docs: expand rules reference with signatures and per-rule TOC#634
Merged
Conversation
Each rule now documents its constructor signature (taken from source), a one-line description of when it raises a violation, and the previously opaque optional arguments (e.g. the exclude/allow-list parameters). Adds an Imports section so the file is self-contained, and expands the table of contents to link every individual rule. Refs #626 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #634 +/- ##
=========================================
Coverage 98.25% 98.25%
Complexity 700 700
=========================================
Files 87 87
Lines 2000 2000
=========================================
Hits 1965 1965
Misses 35 35 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Expands
docs/rules.mdso it is self-contained and easier to consult (both for humans searching for a rule and for LLM coding agents generating aphparkitect.php).For every rule:
src/Expression/ForClasses/, not from memory)$excludeallow-lists onDependsOnlyOnTheseNamespaces/NotDependsOnTheseNamespacesand$externalDependenciesToExcludeonNotHaveDependencyOutsideNamespaceAlso:
usestatements and the rule that every expression lives underArkitect\Expression\ForClasses(the file had zero imports before, so a reader landing only on this page couldn't write working code)The existing examples are preserved.
Refs #626