Skip to content

Use better inheritance in Roxygen documentation #44

@spencerpease

Description

@spencerpease

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/

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions