Add doc-comment audit workflow#1031
Open
LasmarKhalifa wants to merge 1 commit into
Open
Conversation
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.

Part of #1008
In a nutshell: a Roast workflow that guards against doc-comment drift. It reads the doc comments across the codebase, has an agent check each one against the real implementation, and opens a single PR fixing the stale ones. Read-only by default; it opens a PR only when run with
-- apply.How it works (one cog per phase):
#prose block sitting above a definition (class, module, method, attr, constant), plus its RBS signature.-- apply) splices the fixes in and opens one draft PR on top of the current branch, gated by a check that requires a clean, pushed, even working tree so the PR diff is only the doc fix.Scope defaults to
lib/roastplus the rbi shims; pass files or directories as targets to narrow it.The workflow is heavily commented inline, so that a reader can follow the enumeration and classification logic without having to reverse-engineer it.
Example test run scoped to one file here: https://app.graphite.com/github/pr/Shopify/roast/1034