[
https://issues.apache.org/jira/browse/SPARK-16508?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15380456#comment-15380456
]
Felix Cheung commented on SPARK-16508:
--------------------------------------
Sure, from checking
https://gist.github.com/shivaram/62866c4ca59c5d34b8963939cf04b5eb
1) attach
{code}
* checking R code for possible problems ... NOTE
Found the following calls to attach():
File ‘SparkR/R/DataFrame.R’:
attach(newEnv, pos = pos, name = name, warn.conflicts = warn.conflicts)
See section ‘Good practice’ in ‘?attach’.
?attach
Good practice:
‘attach’ has the side effect of altering the search path and this
can easily lead to the wrong object of a particular name being
found. People do often forget to ‘detach’ databases.
In interactive use, ‘with’ is usually preferable to the use of
‘attach’/‘detach’, unless ‘what’ is a ‘save()’-produced file in
which case ‘attach()’ is a (safety) wrapper for ‘load()’.
In programming, functions should not change the search path unless
that is their purpose. Often ‘with’ can be used within a
function. If not, good practice is to
• Always use a distinctive ‘name’ argument, and
• To immediately follow the ‘attach’ call by an ‘on.exit’ call
to ‘detach’ using the distinctive name.
This ensures that the search path is left unchanged even if the
function is interrupted or if code after the ‘attach’ call changes
the search path.
{code}
--> not sure what we should do here, we should avoid exposing "attach" it seems
like.
2. missing documentation
{code}
* checking for missing documentation entries ... WARNING
Undocumented S4 methods:
generic 'cache' and siglist 'RDD'
generic 'collect' and siglist 'RDD'
...
{code}
--> SPARK-16519
3. Missing argument documentation
{code}
checking Rd \usage sections ... WARNING
Undocumented arguments in documentation object 'add_months'
‘y’ ‘x’
...
{code}
--> SPARK-16507
4. window.*
{code}
Functions with \usage entries need to have the appropriate \alias
entries, and all their arguments documented.
The \usage entries must correspond to syntactically valid R code.
See chapter ‘Writing R documentation files’ in the ‘Writing R
Extensions’ manual.
S3 methods shown with full name in documentation object 'window.orderBy':
‘window.orderBy’
S3 methods shown with full name in documentation object 'window.partitionBy':
‘window.partitionBy’
{code}
--> SPARK-16509
> Fix documentation warnings found by R CMD check
> -----------------------------------------------
>
> Key: SPARK-16508
> URL: https://issues.apache.org/jira/browse/SPARK-16508
> Project: Spark
> Issue Type: Sub-task
> Components: SparkR
> Reporter: Shivaram Venkataraman
>
> A full list of warnings after the fixes in SPARK-16507 is at
> https://gist.github.com/shivaram/62866c4ca59c5d34b8963939cf04b5eb
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
