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.

Sign up for GitHub

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

Jump to bottom

Make readme examples part of cargo test #119

Open
nyurik opened this issue Apr 1, 2023 · 0 comments
Open

Make readme examples part of cargo test #119

nyurik opened this issue Apr 1, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@nyurik
Copy link
Member

nyurik commented Apr 1, 2023

Rust markdown examples are usually included as part of the cargo test, but if they are in README, they require some additional snippet of code. Currently, the examples in the readme are non-compilable (they need a few extra lines hidden with the # symbols).
@nyurik nyurik added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels Apr 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@nyurik