docs(linter): Add docs for no-param-reassign config options.#14849
docs(linter): Add docs for no-param-reassign config options.#14849camc314 merged 1 commit intooxc-project:mainfrom
Conversation
This will allow us to auto-gen docs for the config rule when building the website. I believe the note about the rust regex syntax is correct, I based it on the similar comment from the new-cap rule.
How to use the Graphite Merge QueueAdd either label to this PR to merge it via the merge queue:
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. |
There was a problem hiding this comment.
Pull Request Overview
Adds configuration documentation for the no-param-reassign linter rule by implementing the JsonSchema trait and adding doc comments to configuration fields. This enables auto-generation of documentation for the rule's configuration options when building the website.
- Added
JsonSchemaderive and schema attributes toNoParamReassignConfig - Added doc comments describing each configuration option
- Linked the config struct to the rule declaration
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
CodSpeed Performance ReportMerging #14849 will not alter performanceComparing Summary
Footnotes
|
Part of #14743. This will allow us to auto-gen docs for the config rule when building the website.
I believe the note about the rust regex syntax is correct, I based it on the similar comment from the new-cap rule.
Generated docs:
Note 100% sure why there's no default for the regex option, though.