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

Use better inheritance in Roxygen documentation #44

Open
spencerpease opened this issue Apr 25, 2019 · 0 comments
Open

Use better inheritance in Roxygen documentation #44

spencerpease opened this issue Apr 25, 2019 · 0 comments
Labels
enhancement New feature or request

Comments

@spencerpease
Copy link
Contributor

Description

Many of the functions in this package pass on parameters to other functions, so we should make use of inheritance to reduce inconsistent documentation. Some functions already do this, but there is more work to be done.

Roxygen has specific tags for this, such as @inheretParams and @inheretDotParams.

References

https://blog.rstudio.com/2017/02/01/roxygen2-6-0-0/

@spencerpease spencerpease added the enhancement New feature or request label Apr 25, 2019
@spencerpease spencerpease added this to the PWFSLSmokePlots ideas milestone Apr 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant