docs: add module-level documentation#237
Merged
Merged
Conversation
AlfioEmanueleFresta
force-pushed
the
docs-modules
branch
from
ed3bdfe to
b873282
Compare
AlfioEmanueleFresta
changed the base branch from
master
to
issue-160-related-origins
AlfioEmanueleFresta
force-pushed
the
docs-modules
branch
from
b873282 to
5bffca1
Compare
AlfioEmanueleFresta
merged commit feba532
into
issue-160-related-origins
2 checks passed
AlfioEmanueleFresta
added a commit
that referenced
this pull request
May 30, 2026
Adds a short module-level overview to the crate root and each top-level module. Each one is one or two paragraphs describing the module's purpose and its main public types, so the docs.rs landing page and every module page open with context instead of a bare list of items. This is documentation only, with no code changes.
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.
Adds a short module-level overview to the crate root and each top-level module. Each one is one or two paragraphs describing the module's purpose and its main public types, so the docs.rs landing page and every module page open with context instead of a bare list of items.
This is documentation only, with no code changes.