Nothing enforces the documentation the crate already keeps #30
Labels
No labels
kind
bug
kind
enhancement
kind
refactor
workflow
needs-info
workflow
needs-triage
workflow
ready-for-agent
workflow
ready-for-human
workflow
wontfix
No milestone
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
rosa/lucre#30
Loading…
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
src/lib.rssets no#![warn(missing_docs)], so the documentation this cratekeeps thoroughly is kept by hand alone. A new public item arriving undocumented
would reach a release without anything objecting, and the
clippytask runs-D warnings, so the lint would hold the line in CI for free once it passes.It does not pass yet. Seven public fields are undocumented, all of them payloads
on error variants that carry the detail a caller reads:
IsoAlphabeticCodeError::InvalidCode { code }atsrc/lib.rs:1238IsoNumericCodeError::InvalidCode { code }atsrc/lib.rs:1260ExchangeRateError::InvalidRate { rate }atsrc/exchange/rate.rs:528ParsePairError::MissingSeparator { notation }atsrc/exchange/rate.rs:539ParsePairError::UnknownCurrency { code }atsrc/exchange/rate.rs:550ExchangeError::Unquoted { base, quote }— both — atsrc/exchange/table.rs:564Each variant's own doc comment already says what it carries, so the field
comments should add precision the variant comment does not: what the value is
measured in, or which of two plausible readings it takes.
Document the seven, then turn the lint on.
missing_debug_implementationsisthe companion worth considering in the same pass, though every public type
already derives
Debug, so that one passes today.