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

Add readme to doctest #300

Open
ysimonson opened this issue Jun 10, 2023 · 0 comments
Open

Add readme to doctest #300

ysimonson opened this issue Jun 10, 2023 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@ysimonson
Copy link
Member

Just came across this in glob: https://github.com/rust-lang/glob/blob/7b29204bb108a83300b0ce877072fcb62b83316a/src/lib.rs#L70

Looks like a great way to ensure the examples in README are up to date with the latest, whereas at the moment, on breaking changes I hack something together on the README and hope it works.

For examples in the README that can't run via doctests (because it's in python or because it's using gRPC), we'll need to add an attribute to ignore testing: https://doc.rust-lang.org/rustdoc/write-documentation/documentation-tests.html#attributes

@ysimonson ysimonson added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Jun 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant