-
Notifications
You must be signed in to change notification settings - Fork 28k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[SPARK-11756][SPARKR] Fix use of aliases - SparkR can not output help information for SparkR:::summary correctly #9750
Conversation
Test build #46034 has finished for PR 9750 at commit
|
cc @sun-rui |
this PR is documentation only, no code change here |
@yu-iskw would love to have your feedback |
any more comment? |
@yanboliang Could you help us review this PR by trying it out and seeing if it fixes the issue ? |
Sorry for late response. It can fix my issue mentioned at JIRA. But I also found new issues that the generated doc of describe(x, col, ...)
summary(object, ...)
## S4 method for signature 'DataFrame,character'
describe(x, col, ...)
## S4 method for signature 'DataFrame,ANY'
describe(x)
## S4 method for signature 'DataFrame'
summary(object, ...)
## S4 method for signature 'PipelineModel'
summary(object, ...) |
It actually is a common practice to include function for types on the same help page of the function name. |
OK, got it. LGTM for me. Thanks for your PR. |
@@ -254,7 +254,6 @@ setMethod("dtypes", | |||
#' @family DataFrame functions | |||
#' @rdname columns | |||
#' @name columns | |||
#' @aliases names |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
shouldnt we add @seealso names
here ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
name
is on the same doc page as column (maybe we should change @rdname
to names for R friendliness)
#' @rdname columns
#' @name names
setMethod("names",
Thanks @felixcheung -- LGTM. Had some minor inline comments about adding |
Merging this to master and branch-1.6 |
… information for SparkR:::summary correctly Fix use of aliases and changes uses of rdname and seealso `aliases` is the hint for `?` - it should not be linked to some other name - those should be seealso https://cran.r-project.org/web/packages/roxygen2/vignettes/rd.html Clean up usage on family, as multiple use of family with the same rdname is causing duplicated See Also html blocks (like http://spark.apache.org/docs/latest/api/R/count.html) Also changing some rdname for dplyr-like variant for better R user visibility in R doc, eg. rbind, summary, mutate, summarize shivaram yanboliang Author: felixcheung <felixcheung_m@hotmail.com> Closes #9750 from felixcheung/rdocaliases. (cherry picked from commit a6239d5) Signed-off-by: Shivaram Venkataraman <shivaram@cs.berkeley.edu>
Fix use of aliases and changes uses of @rdname and @Seealso
@aliases
is the hint for?
- it should not be linked to some other name - those should be @Seealsohttps://cran.r-project.org/web/packages/roxygen2/vignettes/rd.html
Clean up usage on @family, as multiple use of @family with the same @rdname is causing duplicated See Also html blocks (like http://spark.apache.org/docs/latest/api/R/count.html)
Also changing some @rdname for dplyr-like variant for better R user visibility in R doc, eg. rbind, summary, mutate, summarize
@shivaram @yanboliang