[SPARK-16107] [R] group glm methods in documentation#13820
Conversation
|
ok to test |
|
@shivaram @felixcheung I think this significantly improves the current doc. We can add more content to description later. Do you know how to remove the |
| #' Generalized Linear Models | ||
| #' | ||
| #' Fits a generalized linear model against a Spark DataFrame. | ||
| #' Fit generalized linear model against a Spark DataFrame. Can print, make predictions on the |
There was a problem hiding this comment.
Fit->FitsCan print->Users can print
|
Test build #60967 has finished for PR 13820 at commit
|
|
I think the |
| #' | ||
| #' Fits a generalized linear model, similarly to R's glm(). | ||
| #' | ||
| #' @title Generalized Linear Models (R-compliant) |
There was a problem hiding this comment.
As talked with this discussion #13394 (diff), should we follow first sentence as the convention to define the title in this case?
There was a problem hiding this comment.
I asked @junyangq to try changing #' to # and see whether it works. We still need a comment for the function but we don't want it to appear on the generated Rd doc.
There was a problem hiding this comment.
@junyangq Could you remove @title? We might need an empty line after this line. See attached screenshot:
|
Test build #60974 has finished for PR 13820 at commit
|
|
I think the |
|
Test build #60980 has finished for PR 13820 at commit
|
| #' Fits a generalized linear model, similarly to R's glm(). | ||
| #' | ||
| #' @title Generalized Linear Models (R-compliant) | ||
| #' Fits a generalized linear model, similarly to R's glm(). |
There was a problem hiding this comment.
Remove the extra space between #' and Fits.
| #' Get the summary of a generalized linear model | ||
| #' | ||
| #' Returns the summary of a model produced by glm() or spark.glm(), similarly to R's summary(). | ||
| # Returns the summary of a model produced by glm() or spark.glm(), similarly to R's summary(). |
There was a problem hiding this comment.
I get this is intentional, but I'd suggest adding extra empty newline between # & #' line - it's very easy to newcomers to make mistakes copy/paste lines (and didn't realize it wouldn't output to the doc)
|
Test build #61007 has finished for PR 13820 at commit
|
## What changes were proposed in this pull request? This groups GLM methods (spark.glm, summary, print, predict and write.ml) in the documentation. The example code was updated. ## How was this patch tested? N/A (If this patch involves UI changes, please attach a screenshot; otherwise, remove this)   Author: Junyang Qian <junyangq@databricks.com> Author: Junyang Qian <junyangq@Junyangs-MacBook-Pro.local> Closes #13820 from junyangq/SPARK-16107. (cherry picked from commit ea3a12b) Signed-off-by: Xiangrui Meng <meng@databricks.com>
|
LGTM. Merged into master and branch-2.0. Thanks! @junyangq Please follow @felixcheung 's suggestion and insert an empty line between |
6 participants
What changes were proposed in this pull request?
This groups GLM methods (spark.glm, summary, print, predict and write.ml) in the documentation. The example code was updated.
How was this patch tested?
N/A
(If this patch involves UI changes, please attach a screenshot; otherwise, remove this)