Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation - do or don't repeat yourself #40

Closed
RaphaelS1 opened this issue May 20, 2019 · 1 comment
Closed

Documentation - do or don't repeat yourself #40

RaphaelS1 opened this issue May 20, 2019 · 1 comment

Comments

@RaphaelS1
Copy link
Collaborator

The roxygen mantra is do repeat yourself in documentation. For inheritance this can get quite tedious. Whilst roxygen supports inherited methods, if we inherit every method down every tree, this could get very messy and with method overloading it could also be quite complicated. However, by not either inheriting (via docstrings) or adding each inherited method manually, the user is left to follow a chain of links to find all methods.

Which of the two do we opt for:

  1. Do inherit methods in documentation, via roxygen or manually, leading to long and potentially confusing documentation.
  2. Do not inherit methods, leading to short documentation with missing methods/variables but with links (possibly many) to point to the relevant method/variable documentation
@RaphaelS1 RaphaelS1 added this to To do in V1 Implementation via automation May 20, 2019
@RaphaelS1
Copy link
Collaborator Author

This is forced by #46 and Roxygen documentation, each Class contains a table of links to the individual method help pages.

V1 Implementation automation moved this from To do to Done Jun 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

No branches or pull requests

1 participant