Skip to content

feat(tools): add tool to check for unintentional duplicate documentation#5541

Draft
suzmue wants to merge 1 commit intogoogleapis:mainfrom
suzmue:doc-dup-checker
Draft

feat(tools): add tool to check for unintentional duplicate documentation#5541
suzmue wants to merge 1 commit intogoogleapis:mainfrom
suzmue:doc-dup-checker

Conversation

@suzmue
Copy link
Copy Markdown
Contributor

@suzmue suzmue commented Apr 24, 2026

This change introduces the doc-dup-checker tool in the tools directory. The tool analyzes Rustdoc JSON to find instances where both a re-export and its target have documentation, which rustdoc concatenates 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

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 24, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.76%. Comparing base (b1d4cb3) to head (1acea9c).
⚠️ Report is 7 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5541   +/-   ##
=======================================
  Coverage   97.76%   97.76%           
=======================================
  Files         219      219           
  Lines       50665    50665           
=======================================
  Hits        49531    49531           
  Misses       1134     1134           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@suzmue suzmue force-pushed the doc-dup-checker branch from 301626d to 1acea9c Compare May 5, 2026 20:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant