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

Docs: document missing stuff #3

Merged
merged 9 commits into from
Jan 3, 2025
Merged

Docs: document missing stuff #3

merged 9 commits into from
Jan 3, 2025

Conversation

bluthej
Copy link
Owner

@bluthej bluthej commented Jan 2, 2025

I had sprinkled a few allow(unused) attributes to silence the lint, so it was time to fix that.

I took that opportunity to change the visibility of a few items.

It turns out if an item is declared as `pub` then it's OK for it to be
"unused", but not if it's just `pub(crate)`.
This attribute should have been read!
Made most of these public items.
Got influenced by Python docstrings, in Rust we actually use the
3rd person for functions!
@codecov-commenter
Copy link

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

@bluthej bluthej merged commit 9d4dce1 into main Jan 3, 2025
16 checks passed
@bluthej bluthej deleted the docs/deny-missing-docs branch January 3, 2025 10:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants