Repository navigation
📝 docs: deny missing_docs and document all public items - #2573
Merged
Merged
Conversation
Enable `missing_docs = "deny"` through workspace lints for every crate under crates/ and add the doc comments it requires. Clap ValueEnum variants in mq-run keep `#[allow(missing_docs)]` so `--help` output is unchanged.
Diagnostic messages change from "... — ..." to comma-separated text. The markdown formatter now renders help as "(help: ...)".
Lower the workspace missing_docs lint from deny to warn. Correct copy-pasted or inaccurate doc comments in mq-check, mq-lang and mq-markdown, and reword the mq-lint rule docs as full sentences.
Merging this PR will not alter performance
Comparing 
Footnotes
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Enable
missing_docs = "warn"through workspace lints for every crate under crates/ and add the doc comments it requires.Clap ValueEnum variants in mq-run keep
#[allow(missing_docs)]so--helpoutput is unchanged.Type of Change
Checklist
cargo fmtandcargo clippyand addressed any warningsjust test-alland all tests pass/docs, crateREADME.md) if neededAdditional Context