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

Move code examples out from docs #630

Open
rytilahti opened this issue Jan 10, 2024 · 0 comments
Open

Move code examples out from docs #630

rytilahti opened this issue Jan 10, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@rytilahti
Copy link
Member

rytilahti commented Jan 10, 2024

Code examples could be moved out from the docs to make them easier for library users to find, and we can add some tests to keep them working in the future.

..literalinclude can be used to show them inside the docs.

I think we should probably "externalize" these examples into regular .py files to allow testing them, as I'm worried about documentation rot over time. This can be done in a separate PR at some later point though, so just make sure the example script is working for now.

Originally posted by @rytilahti in #614 (comment)

@rytilahti rytilahti added the documentation Improvements or additions to documentation label Jan 10, 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
None yet
Development

No branches or pull requests

1 participant