Add Documentation DO/DON'T section in agents.md#1103
Open
suri-kumkaran wants to merge 2 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds contributor guidance to keep Rust documentation focused on durable semantics rather than duplicating rustdoc output, helping prevent module/item docs from drifting into manually maintained type/signature listings.
Changes:
- Adds a new “Documentation” DO/DON’T section to
agents.md. - Encourages using
cargo doc --no-depsto rely on rustdoc-generated structure (signatures, listings, re-exports, links). - Codifies specific anti-patterns to avoid (manual type/function lists, signature restatements, unnecessary docs for internal visibility items).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1103 +/- ##
==========================================
- Coverage 89.49% 89.46% -0.03%
==========================================
Files 479 482 +3
Lines 90337 91092 +755
==========================================
+ Hits 80844 81497 +653
- Misses 9493 9595 +102
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
magdalendobson
approved these changes
May 26, 2026
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
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
DocumentationDO/DON'T section toagents.mdalongside the existingTest Patternsblock.Surfaced during review of #1027 and other PRs, where module- and item-level docs drifted toward manually-maintained type listings and signature restatements. New section captures the "less is more" framing, reminds agents not to duplicate what rustdoc already provides, and codifies the three patterns the reviewer called out as noise.