GitHub user felixcheung opened a pull request:
https://github.com/apache/spark/pull/9463
[SPARK-11263][SPARKR] lintr Throws Warnings on Commented Code in
Documentation
Clean out hundreds of `style: Commented code should be removed.` from lintr
Like these:
```
/opt/spark-1.6.0-bin-hadoop2.6/R/pkg/R/DataFrame.R:513:3: style: Commented
code should be removed.
# sc <- sparkR.init()
^~~~~~~~~~~~~~~~~~~
/opt/spark-1.6.0-bin-hadoop2.6/R/pkg/R/DataFrame.R:514:3: style: Commented
code should be removed.
# sqlContext <- sparkRSQL.init(sc)
^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/opt/spark-1.6.0-bin-hadoop2.6/R/pkg/R/DataFrame.R:515:3: style: Commented
code should be removed.
# path <- "path/to/file.json"
^~~~~~~~~~~~~~~~~~~~~~~~~~~
```
tried without @export or @rdname, neither work
instead, added this `#' @noRd` to suppress .Rd file generation
also updated `@family` for DataFrame functions for longer descriptive text
instead of `dataframe_funcs`
this covers *most* of 'Commented code' but I left out a few that looks
legitimate.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/felixcheung/spark rlintr
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/spark/pull/9463.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #9463
----
commit 4b136b3c7ec150e1fc2005f7d5b93015801f9e77
Author: felixcheung <[email protected]>
Date: 2015-11-04T09:05:08Z
Clean out a lot of lintr complains particularly with commented code
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
