Skip to content

docs: mark project rules in the rules list - #1829

Merged
bhirsz merged 1 commit into
feat/rule-circular-importfrom
feat/docs-project-rules
Aug 14, 2026
Merged

docs: mark project rules in the rules list#1829
bhirsz merged 1 commit into
feat/rule-circular-importfrom
feat/docs-project-rules

Conversation

@bhirsz

@bhirsz bhirsz commented Aug 14, 2026

Copy link
Copy Markdown
Member

Makes project rules visible in the documentation and in the CLI:

  • new Rule.project_rule attribute,
  • generated rules list renders a Project rule note with a link to the project checks docs,
  • robocop list rules tags such rules with [project],
  • new robocop list rules --filter PROJECT,
  • the repeated 'This rule is a project level rule' paragraph was removed from the rule docstrings,
  • test asserting that project_rule matches rules reported by ProjectChecker.

Stacked on #1828.

@bhirsz
bhirsz marked this pull request as ready for review August 14, 2026 16:46
@bhirsz
bhirsz force-pushed the feat/docs-project-rules branch from 8684239 to 7da8785 Compare August 14, 2026 16:50
Add Rule.project_rule attribute, render a note for project rules in the generated rules list, tag them with [project] in 'robocop list rules' and add a PROJECT list filter.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@bhirsz
bhirsz force-pushed the feat/docs-project-rules branch from 7da8785 to f39164e Compare August 14, 2026 16:56
@bhirsz
bhirsz merged commit 09dd54a into main Aug 14, 2026
11 checks passed
@bhirsz
bhirsz deleted the feat/docs-project-rules branch August 14, 2026 17:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant