feat(tools): add tool to check for unintentional duplicate documentation#5541
Draft
suzmue wants to merge 2 commits intogoogleapis:mainfrom
Draft
feat(tools): add tool to check for unintentional duplicate documentation#5541suzmue wants to merge 2 commits intogoogleapis:mainfrom
suzmue wants to merge 2 commits intogoogleapis:mainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5541 +/- ##
==========================================
- Coverage 97.75% 97.75% -0.01%
==========================================
Files 218 218
Lines 49498 49498
==========================================
- Hits 48389 48388 -1
- Misses 1109 1110 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
This change introduces the
doc-dup-checkertool in thetoolsdirectory. The tool analyzes Rustdoc JSON to find instances where both a re-export and its target have documentation, whichrustdocconcatenates in the generated HTML.The tool supports workspace-wide scanning of handwritten, published crates. It respects intentional paragraph breaks in re-export documentation as exceptions.
This does not yet add the tool to CI.
For #5481