Skip to content

docs: fix broken link and minor wording in suppression.md#3527

Merged
MichaReiser merged 2 commits into
astral-sh:mainfrom
jpatel3:docs/suppression-cleanup
May 24, 2026
Merged

docs: fix broken link and minor wording in suppression.md#3527
MichaReiser merged 2 commits into
astral-sh:mainfrom
jpatel3:docs/suppression-cleanup

Conversation

@jpatel3

@jpatel3 jpatel3 commented May 24, 2026

Copy link
Copy Markdown
Contributor

Summary

Small cleanup of docs/suppression.md:

  • Fix malformed anchor link: rules.md/#rule-levelsrules.md#rule-levels. The extra / before the fragment makes the URL point at a rules.md/ directory instead of the file with an anchor.
  • Drop a duplicated verb in the note about enumerating rule names: "we strongly recommend including suppressing specific rules" → "we strongly recommend including specific rules".
  • Make the "Multiple suppressions comments" heading match its siblings ("ty suppression comments", "Standard suppression comments", "Unused suppression comments"): "Multiple suppressions comments" → "Multiple suppression comments". No other docs link to this anchor, so this rename is safe.

Test Plan

  • mdformat docs/suppression.md --check passes
  • markdownlint-cli@0.48.0 docs/suppression.md passes
  • Verified the #rule-levels anchor exists in docs/rules.md

- Fix malformed anchor link `rules.md/#rule-levels` → `rules.md#rule-levels`
- Drop duplicated verb in "including suppressing specific rules"
- Match heading wording to neighbors: "Multiple suppressions comments"
  → "Multiple suppression comments"
@MichaReiser MichaReiser added the documentation Improvements or additions to documentation label May 24, 2026
Comment thread docs/suppression.md Outdated
!!! note

To disable a rule entirely, set it to the `ignore` level as described in [rule levels](rules.md/#rule-levels).
To disable a rule entirely, set it to the `ignore` level as described in [rule levels](rules.md#rule-levels).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The link here works fine

Comment thread docs/suppression.md Outdated
@MichaReiser

Copy link
Copy Markdown
Member

thank you.

For your next PR, please make sure you read our AI use policy.

@MichaReiser MichaReiser enabled auto-merge (squash) May 24, 2026 07:31
@MichaReiser MichaReiser disabled auto-merge May 24, 2026 07:31
@MichaReiser MichaReiser enabled auto-merge (squash) May 24, 2026 07:31
@MichaReiser MichaReiser merged commit 4e1b4e7 into astral-sh:main May 24, 2026
15 checks passed
@jpatel3

jpatel3 commented May 26, 2026

Copy link
Copy Markdown
Contributor Author

thank you.

For your next PR, please make sure you read our AI use policy.

Sure will do @MichaReiser

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants