Skip to content

Lint for missing docs in all items #22

Closed

Description

@nfejzic

We want to uphold high quality, easy maintenance and enable contributors to become productive as fast as possible in trafix. To achieve this, we already have clippy::pedantic lints enabled to aid in good practices.

We also want to ensure that we provide good documentation. Public documentation is extremely important for users of the crate, and hence we should add warn(missing_docs). However, to aid in onboarding of contributors, ease of maintenance and general development experience, we should also add warnings for clippy::missing_docs_in_private_items lint.

Activity

  1. self-assigned this
    on Dec 18, 2025
  2. added theissue type on Dec 18, 2025
  3. added this to the trafix-codec-v0.1.0 milestone on Dec 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions