You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@spark.apache.org by "Apache Spark (JIRA)" <ji...@apache.org> on 2017/06/20 17:19:00 UTC

[jira] [Commented] (SPARK-20889) SparkR grouped documentation for Column methods

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

Apache Spark commented on SPARK-20889:
--------------------------------------

User 'actuaryzhang' has created a pull request for this issue:
https://github.com/apache/spark/pull/18366

> SparkR grouped documentation for Column methods
> -----------------------------------------------
>
>                 Key: SPARK-20889
>                 URL: https://issues.apache.org/jira/browse/SPARK-20889
>             Project: Spark
>          Issue Type: Documentation
>          Components: SparkR
>    Affects Versions: 2.1.1
>            Reporter: Wayne Zhang
>            Assignee: Wayne Zhang
>              Labels: documentation
>             Fix For: 2.3.0
>
>
> Group the documentation of individual methods defined for the Column class. This aims to create the following improvements:
> - Centralized documentation for easy navigation (user can view multiple related methods on one single page).
> - Reduced number of items in Seealso.
> - Betters examples using shared data. This avoids creating a data frame for each function if they are documented separately. And more importantly, user can copy and paste to run them directly!
> - Cleaner structure and much fewer Rd files (remove a large number of Rd files).
> - Remove duplicated definition of param (since they share exactly the same argument).
> - No need to write meaningless examples for trivial functions (because of grouping).



--
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