Docs: No crate-level documentation in lib.rs#176
Open
kumburovicbranko682-boop wants to merge 1 commit into
Open
Conversation
The crate is published on crates.io (Cargo.toml has `description`, `repository`, `keywords`, `categories`) but `src/lib.rs` has zero `//!` doc comments. This means the docs.rs landing page and `cargo doc` output are completely blank — no overview, no usage examples, no feature-flag explanation. For a library crate that downstream consumers (nix packages, homebrew formula, etc.) build against, this is the most visible documentation surface. Consumers have no idea what the public modules do, which features to enable, or how to use the exported API. Affected files: lib.rs Signed-off-by: kumburovicbranko682-boop <295886834+kumburovicbranko682-boop@users.noreply.github.com>
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.
Problem
The crate is published on crates.io (Cargo.toml has
description,repository,keywords,categories) butsrc/lib.rshas zero//!doc comments. This means the docs.rs landing page andcargo docoutput are completely blank — no overview, no usage examples, no feature-flag explanation. For a library crate that downstream consumers (nix packages, homebrew formula, etc.) build against, this is the most visible documentation surface. Consumers have no idea what the public modules do, which features to enable, or how to use the exported API.Severity:
highFile:
src/lib.rsSolution
Add crate-level documentation at the top of
src/lib.rs:Changes
src/lib.rs(modified)Testing