Skip to content

Use @inheritParams functionality in documentation #32

Description

@Lextuga007

When you have arguments documented in multiple functions, but they share the same description, it can be neater to document the argument in one function only and then use @inheritParams in other functions so that if you do alter the text you only have to update it in one place.
See https://r-pkgs.org/man.html#inheriting-arguments for details.

Originally posted by @francisbarton in #21

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions