Github user actuaryzhang commented on the issue:
https://github.com/apache/spark/pull/18025
@felixcheung Thanks for asking this. I should have been more clear.
`@name` is the "name" of the Rd object represented, which is unique. An Rd
object can have multiple aliases pointing to the same Rd. Usually, when one
specifies `@name xxx`, there will be a `@alias xxx` automatically created to
reference `xxx`.
In the `avg` case, I actually don't need `@name avg`, since the doc of
`avg` goes to `column_aggregate_functions`. In the new commit, I used `@aliases
avg avg,Column-method` which creates two aliases `avg` and `avg,Column-method`.
It now allows the following shortcut for help search which all direct to
the Rd object `column_aggregate_functions` (the `@name` object):
- `?avg`
- `?"avg,Column-method"`
- `help("avg")`
- `?column_aggregate_functions`
- Indeed, since this is S4 method, we can also do `method?avg("Column")`.
Details of R documentation here:
https://cran.r-project.org/doc/manuals/r-release/R-exts.html#Writing-R-documentation-files
---
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 infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org
