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

Add crate-level documentation #16

Open
fwcd opened this issue Jun 1, 2024 · 0 comments
Open

Add crate-level documentation #16

fwcd opened this issue Jun 1, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@fwcd
Copy link
Member

fwcd commented Jun 1, 2024

It would be nice to have a proper introduction and perhaps even an example in a crate-level doc comment (//!). These snippets additionally have the advantage of automatically being compiled during testing.
@fwcd fwcd added the documentation Improvements or additions to documentation label Jun 1, 2024
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
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@fwcd