[ 
https://issues.apache.org/jira/browse/SPARK-11756?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15007792#comment-15007792
 ] 

Felix Cheung commented on SPARK-11756:
--------------------------------------

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

> SparkR can not output help information for SparkR:::summary correctly
> ---------------------------------------------------------------------
>
>                 Key: SPARK-11756
>                 URL: https://issues.apache.org/jira/browse/SPARK-11756
>             Project: Spark
>          Issue Type: Bug
>          Components: R, SparkR
>            Reporter: Yanbo Liang
>
> R users often get help information for a method like this:
> {code}
> > ?summary
> {code}
> or 
> {code}
> > help(summary)
> {code}
> For SparkR we should provide the help information for the SparkR package and 
> base R package(usually stats package).
> But for "summary" method, it can not output the help information correctly.
> {code}
> > help(summary)
> Help on topic ‘summary’ was found in the following packages:
>   Package               Library
>   SparkR                /Users/yanboliang/data/trunk2/spark/R/lib
>   base                  /Library/Frameworks/R.framework/Resources/library
> Choose one 
> 1: describe {SparkR}
> 2: Object Summaries {base}
> {code}
> It can only output the help of describe(DataFrame) which is synonymous with 
> summary(DataFrame), we also need the help information of 
> summary(PipelineModel).



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@spark.apache.org
For additional commands, e-mail: issues-h...@spark.apache.org

Reply via email to