Skip to content

[Docs] Update ggplot2_args roxygen2 template or integrate with shared_params #695

@averissimo

Description

@averissimo

@kartikeyakirar found an interesting thing on the documentation about the @template tag

Q: Should we keep using the @template tag? (it has been superseded)
take a look at man-roxygen/ggplot2_args_multi.R and search for ggplot_2_args_multi

If we stop using it, we can add this parameter to the shared_params definition and add the custom information to @details

Context

{tmg} is using the @template roxygen tag to add a "customizable" parameter ggplot2_args.

This template allows a special <%=ggnames%> string that defines a placeholder for a ggnames variable and, thus, has a custom documentation for each time it's used. (to supply different allowable values)

This tag has been superseded by {roxygen2} in favour of inline code.

Definition of Done

  • ggplot2_args roxygen @template needs updating along with rest of documentation
  • Move file under man/roxygen/template
    • Or integrate with shared_params & add specific context to individual man pages.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingcore

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions