[ https://issues.apache.org/jira/browse/SPARK-23073?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Hyukjin Kwon resolved SPARK-23073. ---------------------------------- Resolution: Incomplete > Fix incorrect R doc page header for generated sql functions > ----------------------------------------------------------- > > Key: SPARK-23073 > URL: https://issues.apache.org/jira/browse/SPARK-23073 > Project: Spark > Issue Type: Documentation > Components: SparkR > Affects Versions: 2.2.1, 2.3.0 > Reporter: Felix Cheung > Priority: Minor > Labels: bulk-closed > Attachments: Screen Shot 2018-01-14 at 11.11.05 AM.png > > > See title says > {code} > asc {SparkR} > {code} > https://dist.apache.org/repos/dist/dev/spark/v2.3.0-rc1-docs/_site/api/R/columnfunctions.html > http://spark.apache.org/docs/latest/api/R/columnfunctions.html > asc, contains etc are functions generated at runtime. Because of that, their > doc entries are dependent on the Generics.R file. Unfortunately, ROxygen2 > picks the doc page title from the first function name by default, in the > presence of any function it can parse. > An attempt to fix here > https://github.com/apache/spark/pull/20263/commits/d433dc930021de85aa338c5017a223bae3526df3#diff-8e3d61ff66c9ffcd6ffb7a8eedc08409R824 > {code} > #' @rdname columnfunctions > #' @export > +#' @name NULL > setGeneric("asc", function(x) { standardGeneric("asc") }) > {code} > But it cause a more severe issue to fail CRAN checks > {code} > * checking for missing documentation entries ... WARNING > Undocumented code objects: > 'asc' 'contains' 'desc' 'getField' 'getItem' 'isNaN' 'isNotNull' > 'isNull' 'like' 'rlike' > All user-level objects in a package should have documentation entries. > See the chapter 'Writing R documentation files' in the 'Writing R > Extensions' manual. > * checking for code/documentation mismatches ... OK > * checking Rd \usage sections ... WARNING > Objects in \usage without \alias in documentation object 'columnfunctions': > 'asc' 'contains' 'desc' 'getField' 'getItem' 'isNaN' 'isNull' > 'isNotNull' 'like' 'rlike' > {code} > To follow up we should > - look for a way to set the doc page title > - http://spark.apache.org/docs/latest/api/R/columnfunctions.html is really > barebone and we should explicitly add a doc page with content (which could > also address the first point) -- This message was sent by Atlassian Jira (v8.3.4#803005) --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@spark.apache.org For additional commands, e-mail: issues-h...@spark.apache.org