Skip to content

No rustdoc gate in CI and about 42 undocumented public items #57

Description

@vyncint

Today — CI has no cargo doc step (just ci is fmt, clippy, test, deny, schemas, pins, skill) and no crate enables missing_docs. Measured on 3822283: cargo doc --workspace --no-deps produces 0 warnings today, so adding the gate costs nothing. A scan finds about 42 undocumented public items: 14 in launchbound-bench, 8 in -space, 5 of 6 in -tui, 5 in -report, 4 in -build, the rest scattered.

Fix. A docs recipe (RUSTDOCFLAGS=-D warnings cargo doc --workspace --no-deps) in just ci; #![warn(missing_docs)] in every library crate; then document the 42, with invariants and a runnable example on the public entry points (enumerate, decide, estimate).

Done when

  • The doc gate is in just ci and green with missing_docs on.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions