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

General Issue: Implement roxygen roclet to add titles and descriptions to examples #2585

Open
bundfussr opened this issue Nov 29, 2024 · 0 comments
Assignees

Comments

@bundfussr
Copy link
Collaborator

Background Information

A roxygen roclet defines how the roxygen tags in the function header are processed and how the man pages are generated. A roclet should be implemented such that a @title (and a @description tag) can be added for examples. Then each example gets a subsection with title and optionally a description. This helps navigating documentation of functions with many long examples like derive_var_extreme_flag().
See https://roxygen2.r-lib.org/articles/extending.html and https://roxygen2.r-lib.org/reference/roclet.html for some guidance on implementing roxygen roclets.

Benefits:

  • More examples can be added without loosing readability.
  • Finding and navigating the examples is improved.
  • The reference pages can be used to train AI/LLM tools which should propose admiral function calls from plain English descriptions.

Definition of Done

A roclet is implemented.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

1 participant