Github user felixcheung commented on the issue:
https://github.com/apache/spark/pull/14705
I think it's ok to put @param ... on top of the function in the order we
want it. Or @param na.rm for sd, var etc. Yes it is a bit odd to have param in
the documentation block that is not in the immediate signature, but to me it
seems better than making the API contract weaker just so we could document it
(or get some warnings to go away).
We could consider this as you need to include both function definition and
generic definition for documentation and the place to do that is on top of the
function definition (which is just for maintainability and convenient).
Other packages have opted to maintain separate Rd files which could have
other issues.
I don't want to drag this PR on though. We could address the warnings now
and revisit later - I am concerned with adding params to function signature
that weaken it.
---
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]
