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

Other Model Examples #67

Closed
milobanks opened this issue Jan 8, 2025 · 1 comment
Closed

Other Model Examples #67

milobanks opened this issue Jan 8, 2025 · 1 comment
Assignees
Labels
development Towards development documentation Improvements or additions to documentation

Comments

@milobanks
Copy link
Collaborator

What exactly do you (@gvegayon) want to do here? In the document, it states:

We need to create examples replicating other models.

I'm not sure I see the value in this, and would like your input. A lot of these models are slight variations on other similar models, and creating examples for all of them, I feel, is both a little confusing and raises the overhead for any API changes that might occur in the future (i.e. remembering to change every example). The way it currently is in the R repository homepage is something I think that might be a good balance; explain how to use certain models, how to get data out of them, and then defer to the auto-generated API documentation for information on other models.

@milobanks milobanks added documentation Improvements or additions to documentation development Towards development labels Jan 8, 2025
@milobanks milobanks self-assigned this Jan 8, 2025
@milobanks
Copy link
Collaborator Author

We're mostly fine here, defer to demo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
development Towards development documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant