Skip to content

feat(apidocs): Add rule summaries and a legend to the report card - #132024

Merged
akhilp117 merged 4 commits into
masterfrom
akhilpindiprolu/eng-9080-rule-summaries
Nov 20, 2026
Merged

akhilp117 merged 4 commits into
masterfrom
akhilpindiprolu/eng-9080-rule-summaries

Conversation

@akhilp117

@akhilp117 akhilp117 commented Nov 20, 2026 •

Copy link
Copy Markdown
Contributor
image

(part 1 of 2 for issue
Prints a legends at the bottom of running make-api-report-card to know what the flake rules mean. I put the summaries in RULE_SUMMARIES in rules.py and wrote one for all 8 rules, not just the baselined ones since the slack post and the PR warnings are going to use the same text later. The legend is built from rule_columns() so it always lines up with whatever columns the table has. The columns themselves stay as codes so the table doesn't get super wide

@akhilp117
akhilp117 requested a review from a team as a code owner November 20, 2026 16:46
@linear-code

linear-code Bot commented Nov 20, 2026

Copy link
Copy Markdown

ENG-9080

@github-actions github-actions Bot added the Scope: Backend Automatically applied to PRs that change backend components label Nov 20, 2026
@akhilp117
akhilp117 force-pushed the akhilpindiprolu/eng-9080-rule-summaries branch from 58f016d to e48b619 Compare November 20, 2026 16:54

@DominikB2014 DominikB2014 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, but i think we should followup with a cleanup

Comment thread tools/api_guidelines/rules.py Resolved
@akhilp117
akhilp117 merged commit 1c13f34 into master Nov 20, 2026
74 checks passed
@akhilp117
akhilp117 deleted the akhilpindiprolu/eng-9080-rule-summaries branch November 20, 2026 21:08

This branch was successfully deployed

1 active deployment
Preview — f1f0101d Deployed Nov 20, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Scope: Backend Automatically applied to PRs that change backend components

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants