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

Link docs to example folder #371

Open
odunbar opened this issue Mar 19, 2024 · 0 comments · May be fixed by #392
Open

Link docs to example folder #371

odunbar opened this issue Mar 19, 2024 · 0 comments · May be fixed by #392

Comments

@odunbar
Copy link
Collaborator

odunbar commented Mar 19, 2024

Issue

Arising in our CES-sister repo. Commonly users read the docs and do not realize that there are fully coded examples the docs refer to. In particular the docs snippets may not reproducible, but the examples are.

Solution

Add an info block with a link to the examples directory may help folks run the example code.

e.g. the solution here
CliMA/CalibrateEmulateSample.jl#290

@odunbar odunbar linked a pull request Aug 7, 2024 that will close this issue
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant