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

Use #![doc = include_str!("../README.md")] #426

Closed
tarcieri opened this issue Nov 10, 2022 · 1 comment
Closed

Use #![doc = include_str!("../README.md")] #426

tarcieri opened this issue Nov 10, 2022 · 1 comment

Comments

@tarcieri
Copy link
Contributor

src/lib.rs contains large blocks of copy/paste from README.md.

The #![doc = include_str!("../README.md")] directive can be used to include the README.md in the rustdoc, eliminating the duplication, and ensuring all code examples in README.md are also doctested.
@pinkforest pinkforest mentioned this issue Nov 11, 2022
Merged
@pinkforest
Copy link
Contributor

#429 was merged so this can be closed as Resolved

@rozbb rozbb closed this as completed Nov 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@tarcieri @rozbb @pinkforest