Context
Preparing to publish 0.5.0 to crates.io. A doc review turned up a few things to clean up first.
Items
Broken doc links in twine-observers lib.rs
Lines 26–27 link to PlotObserver and ShowConfig via intra-doc links, but those items are behind the plot feature gate. When crates.io builds docs without that feature, rustdoc emits warnings and the links are dead.
Fix: use cfg_attr(doc, doc = ...) to conditionally qualify the links so docs.rs resolves them when the feature is enabled.
No crate-level doc on twine-core
crates/core/src/lib.rs has no //! comment. This is the front page on docs.rs — needs at least a short description of what the crate provides.
No module-level docs on equation and optimization in twine-solvers
crates/solvers/src/equation.rs and crates/solvers/src/optimization.rs have no //! module docs. These are navigational entry points on docs.rs.
Context
Preparing to publish 0.5.0 to crates.io. A doc review turned up a few things to clean up first.
Items
Broken doc links in
twine-observerslib.rsLines 26–27 link to
PlotObserverandShowConfigvia intra-doc links, but those items are behind theplotfeature gate. When crates.io builds docs without that feature, rustdoc emits warnings and the links are dead.Fix: use
cfg_attr(doc, doc = ...)to conditionally qualify the links so docs.rs resolves them when the feature is enabled.No crate-level doc on
twine-corecrates/core/src/lib.rshas no//!comment. This is the front page on docs.rs — needs at least a short description of what the crate provides.No module-level docs on
equationandoptimizationintwine-solverscrates/solvers/src/equation.rsandcrates/solvers/src/optimization.rshave no//!module docs. These are navigational entry points on docs.rs.