Github user actuaryzhang commented on the issue:
https://github.com/apache/spark/pull/18025
@felixcheung I think we may want to distinguish a few cases:
1. For methods that are mainly defined by only one class, e.g., most
function methods for Column, it makes sense to group and document them
together. For example, most aggregate functions of Column go into one single
Rd, since they are not defined for other classes. In this case, `avg` will go
to this doc since it is not used by other classes.
2. For methods that are defined by multiple classes, e.g., the `show`
method defined for SparkDataFrame, GroupedData, Column and StreamingQuery, we
can still document them in `show.Rd`. In this case, `show` will go to this doc
and shows the help for all classes that have defined a `show` method.
3. When it makes sense, we can also combine 1 & 2 above. For example,
`gapply` and `gapplyCollecte` are defined for both SparkDataFrame and
GroupedData. But we can still document them together and create shared
examples.
Let me know if this makes sense.
---
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]
