Skip to content

Conversation

@kfejzic
Copy link
Member

@kfejzic kfejzic commented Dec 18, 2025

What?

This PR introduces the clippy::missing_docs_in_private_items warn rule.

Why?

To uphold high quality, easy maintenance and enable contributors to become productive as fast as possible.

How?

By introducing the clippy::missing_docs_in_private_items in lib.rs and adding the missing doc comments.

Notes

N/A

Checklist

  • Tests are added/updated.
  • Documentation is added/updated.
  • Self-review of code changes completed.

Related Issues

Closes #22

@kfejzic kfejzic added this to the trafix-codec-v0.1.0 milestone Dec 18, 2025
@kfejzic kfejzic requested a review from nfejzic December 18, 2025 22:07
@kfejzic kfejzic self-assigned this Dec 18, 2025
@kfejzic kfejzic added the documentation Improvements or additions to documentation label Dec 18, 2025
@kfejzic kfejzic linked an issue Dec 18, 2025 that may be closed by this pull request
Copy link
Member

@nfejzic nfejzic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🐲! Left some suggestions that can be addressed, but approving this in any case!

kfejzic and others added 3 commits December 19, 2025 02:24
Co-authored-by: Nadir Fejzić <nadir@notfloor.com>
Co-authored-by: Nadir Fejzić <nadir@notfloor.com>
@kfejzic kfejzic requested a review from nfejzic December 19, 2025 01:26
Copy link
Member

@nfejzic nfejzic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🐉

@nfejzic nfejzic merged commit 818e48a into main Dec 19, 2025
4 checks passed
@nfejzic nfejzic deleted the 22-lint-for-missing-docs-in-all-items branch December 19, 2025 01:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Lint for missing docs in all items

3 participants