refactor(docs): enable missing_docs and broken_intra_doc_links denials (#343)#380
Merged
Conversation
- `utils::time::units_per_year`: explain the annualisation helper. - `visualization::plotly::Graph`: describe the trait contract and the default impl split across the `plotly` / `static_export` features. - `model::decimal::tests`: one-line description for the pub test module so `missing_docs` accepts the doctest-wired visibility. - `volatility::utils`: fix broken intra-doc link `DecimalError::Overflow` → `crate::error::DecimalError::Overflow`. Unblocks PR #380 under `#![deny(missing_docs, rustdoc::broken_intra_doc_links)]`.
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
1 participant
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.
Enable crate-level missing_docs and rustdoc::broken_intra_doc_links denials to enforce comprehensive documentation. Closes #343