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.

Sign up for GitHub

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

Jump to bottom

Auto-generate docs/ based upon Roxygen documentation of Experiment parts #201

Open
tiffanymtang opened this issue Jan 6, 2025 · 0 comments
Open

Auto-generate docs/ based upon Roxygen documentation of Experiment parts #201

tiffanymtang opened this issue Jan 6, 2025 · 0 comments
Assignees
@tiffanymtang
Labels
enhancement New feature or request

Comments

@tiffanymtang
Copy link
Collaborator

Currently, users must manually provide docs for DGPs, Methods, Evaluators, and Visualizers that are part of the Experiment. If users use Roxygen to document these functions, it would be nice to take those Roxygen docs and autopopulate the docs used in render_docs().
@tiffanymtang tiffanymtang added the enhancement New feature or request label Jan 6, 2025
@tiffanymtang tiffanymtang self-assigned this Jan 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tiffanymtang tiffanymtang

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@tiffanymtang