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

Recommended doc page to link to for distribution objects? #31

Closed
mjskay opened this issue Jun 12, 2020 · 3 comments
Closed

Recommended doc page to link to for distribution objects? #31

mjskay opened this issue Jun 12, 2020 · 3 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@mjskay
Copy link
Contributor

mjskay commented Jun 12, 2020

As I'm writing docs in ggdist about support for distributional, I find myself looking for a central help page on distribution objects --- something the docs for the dist aesthetic can point to as a good jumping-off point for readers to learn about them. Is there such a page? I wasn't able to find one but I might have missed it. If there isn't, it could be helpful to have :). Thanks!

@mitchelloharawild
Copy link
Owner

Best consolidated resource for this is the pkgdown reference at the moment.
A vignette and/or auto-generated distribution listing would be useful for this.

@mitchelloharawild mitchelloharawild added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 13, 2020
@mjskay
Copy link
Contributor Author

mjskay commented Jun 13, 2020

Thanks! I'll point to the pkgdown for now

@mitchelloharawild
Copy link
Owner

I think long term the pkgdown documentation is the best link, and as needed I'll extend the README with links to the most important learning resources (vignettes, lists of distributions, etc).

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 enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants