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

Combine documentation of similar functions #67

Open
jamesmbaazam opened this issue Sep 12, 2023 · 0 comments
Open

Combine documentation of similar functions #67

jamesmbaazam opened this issue Sep 12, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@jamesmbaazam
Copy link
Member

Ideally, all the *_ll() and simulate_*() family of functions should have joint documentation to make them easier to look up and reduce duplication. Roxygen2's guide on cross referencing provides help on how to do this. See the documentation for dplyr's joins for an example of this use case.

@jamesmbaazam jamesmbaazam added the documentation Improvements or additions to documentation label Sep 12, 2023
@jamesmbaazam jamesmbaazam changed the title Group similar functions into families with Roxygen2's @family tag Combine documentation of similar functions Sep 25, 2023
@jamesmbaazam jamesmbaazam added this to the v0.2.0 milestone Jan 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Todo
Development

No branches or pull requests

1 participant