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

Adding code examples to the documentation #590

Open
2 of 3 tasks
armandas opened this issue Oct 12, 2024 · 1 comment
Open
2 of 3 tasks

Adding code examples to the documentation #590

armandas opened this issue Oct 12, 2024 · 1 comment
Labels
documentation Documentation/Examples

Comments

@armandas
Copy link
Contributor

armandas commented Oct 12, 2024

I'm thinking to make documentation more useful and accessible by adding code examples. Would you be happy to accept this?

To start with, I would add just a basic example to the documentation of each module, like in the standard library documentation: https://doc.rust-lang.org/std/vec/index.html

Example:

image

I would also like to make one PR per crate or possibly per module. What to you think?


To do

@Rahix
Copy link
Owner

Rahix commented Oct 12, 2024

Yes please, the documentation is still quite lacking at the moment. I think it may also be a good idea to link to relevant example programs from the docs. I think working through this per-crate is fine, it that works for you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation/Examples
Projects
None yet
Development

No branches or pull requests

2 participants