Skip to content

Pre-0.5.0 release: fix doc warnings and add missing crate-level docs #263

Description

@dyreby

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions