From issues-return-181642-archive-asf-public=cust-asf.ponee.io@spark.apache.org Sun Jan 14 20:19:05 2018 Return-Path: X-Original-To: archive-asf-public@eu.ponee.io Delivered-To: archive-asf-public@eu.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by mx-eu-01.ponee.io (Postfix) with ESMTP id 3CCDA180651 for ; Sun, 14 Jan 2018 20:19:05 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id 2CD2D160C43; Sun, 14 Jan 2018 19:19:05 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 4B4BA160C22 for ; Sun, 14 Jan 2018 20:19:04 +0100 (CET) Received: (qmail 60240 invoked by uid 500); 14 Jan 2018 19:19:03 -0000 Mailing-List: contact issues-help@spark.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Delivered-To: mailing list issues@spark.apache.org Received: (qmail 60228 invoked by uid 99); 14 Jan 2018 19:19:03 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd1-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 14 Jan 2018 19:19:03 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd1-us-west.apache.org (ASF Mail Server at spamd1-us-west.apache.org) with ESMTP id 0C787C1225 for ; Sun, 14 Jan 2018 19:19:03 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd1-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -100.711 X-Spam-Level: X-Spam-Status: No, score=-100.711 tagged_above=-999 required=6.31 tests=[RCVD_IN_DNSWL_LOW=-0.7, SPF_PASS=-0.001, T_RP_MATCHES_RCVD=-0.01, USER_IN_WHITELIST=-100] autolearn=disabled Received: from mx1-lw-eu.apache.org ([10.40.0.8]) by localhost (spamd1-us-west.apache.org [10.40.0.7]) (amavisd-new, port 10024) with ESMTP id Ep8NMqU384t9 for ; Sun, 14 Jan 2018 19:19:02 +0000 (UTC) Received: from mailrelay1-us-west.apache.org (mailrelay1-us-west.apache.org [209.188.14.139]) by mx1-lw-eu.apache.org (ASF Mail Server at mx1-lw-eu.apache.org) with ESMTP id 485DC5F306 for ; Sun, 14 Jan 2018 19:19:01 +0000 (UTC) Received: from jira-lw-us.apache.org (unknown [207.244.88.139]) by mailrelay1-us-west.apache.org (ASF Mail Server at mailrelay1-us-west.apache.org) with ESMTP id 6E63AE0383 for ; Sun, 14 Jan 2018 19:19:00 +0000 (UTC) Received: from jira-lw-us.apache.org (localhost [127.0.0.1]) by jira-lw-us.apache.org (ASF Mail Server at jira-lw-us.apache.org) with ESMTP id 24B29212FD for ; Sun, 14 Jan 2018 19:19:00 +0000 (UTC) Date: Sun, 14 Jan 2018 19:19:00 +0000 (UTC) From: "Felix Cheung (JIRA)" To: issues@spark.apache.org Message-ID: In-Reply-To: References: Subject: [jira] [Updated] (SPARK-23073) Fix incorrect R doc page header for generated sql functions MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394 [ https://issues.apache.org/jira/browse/SPARK-23073?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Felix Cheung updated SPARK-23073: --------------------------------- Description: 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 content (which could also address the first point) was: See title says {{asc {SparkR}}} 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:java} #' @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 content (which could also address the first point) > 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: SpakrR > Affects Versions: 2.2.1, 2.3.0 > Reporter: Felix Cheung > Priority: Minor > 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 content (which could also address the first point) -- This message was sent by Atlassian JIRA (v6.4.14#64029) --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscribe@spark.apache.org For additional commands, e-mail: issues-help@spark.apache.org