Skip to content

docs(linter): add docs for DisabledRule#15698

Merged
graphite-app[bot] merged 1 commit intomainfrom
c/11-14-docs_linter_add_docs_for_disabledrule_
Dec 10, 2025
Merged

docs(linter): add docs for DisabledRule#15698
graphite-app[bot] merged 1 commit intomainfrom
c/11-14-docs_linter_add_docs_for_disabledrule_

Conversation

@camc314
Copy link
Copy Markdown
Contributor

@camc314 camc314 commented Nov 14, 2025

No description provided.

@github-actions github-actions bot added A-linter Area - Linter C-docs Category - Documentation. Related to user-facing or internal documentation labels Nov 14, 2025
@camc314 Graphite App
Copy link
Copy Markdown
Contributor Author

camc314 commented Nov 14, 2025 •
edited
Loading

How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • 0-merge - adds this PR to the back of the merge queue
  • hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@camc314 camc314 mentioned this pull request Nov 14, 2025
Merged
@camc314 camc314 marked this pull request as ready for review November 14, 2025 13:40
Copilot AI review requested due to automatic review settings November 14, 2025 13:40
@camc314 camc314 self-assigned this Nov 14, 2025
Copilot AI reviewed Nov 14, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds comprehensive documentation to the DisabledRule enum in the linter's disable directives module. The documentation clarifies the purpose and usage of the two variants that handle different types of linting suppression directives.

  • Added detailed documentation for the All and Single variants of the DisabledRule enum
  • Documented all struct fields with clear explanations and examples
  • Included visual examples showing how comment spans and name spans are determined

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@codspeed-hq
Copy link
Copy Markdown

codspeed-hq bot commented Nov 14, 2025 •
edited
Loading

CodSpeed Performance Report

Merging #15698 will not alter performance

Comparing c/11-14-docs_linter_add_docs_for_disabledrule_ (ba345a5) with main (fb4700a)

Summary

✅ 4 untouched
⏩ 41 skipped1

Footnotes

  1. 41 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

@camc314 camc314 force-pushed the c/11-14-docs_linter_add_docs_for_disabledrule_ branch from 0a9563f to ba345a5 Compare December 10, 2025 15:11
@camc314 camc314 added the 0-merge Merge with Graphite Merge Queue label Dec 10, 2025
@graphite-app
Copy link
Copy Markdown
Contributor

graphite-app bot commented Dec 10, 2025 •
edited
Loading

Merge activity

@graphite-app graphite-app bot force-pushed the c/11-14-docs_linter_add_docs_for_disabledrule_ branch from ba345a5 to 271e1ff Compare December 10, 2025 15:16
@graphite-app graphite-app bot merged commit 271e1ff into main Dec 10, 2025
20 checks passed
@graphite-app graphite-app bot deleted the c/11-14-docs_linter_add_docs_for_disabledrule_ branch December 10, 2025 15:20
@graphite-app graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label Dec 10, 2025
@Boshen Boshen mentioned this pull request Dec 15, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

Assignees

@camc314 camc314

Labels

A-linter Area - Linter C-docs Category - Documentation. Related to user-facing or internal documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@camc314