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

["Wayne Zhang (JIRA)" <ji...@apache.org>]

Wayne Zhang created SPARK-20889:
-----------------------------------

             Summary: SparkR grouped documentation for Column methods
                 Key: SPARK-20889
                 URL: https://issues.apache.org/jira/browse/SPARK-20889
             Project: Spark
          Issue Type: Improvement
          Components: SparkR
    Affects Versions: 2.1.1
            Reporter: Wayne Zhang


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.3.15#6346)

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