-
Notifications
You must be signed in to change notification settings - Fork 56
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Document how to customize rules #86
Conversation
Also can I easily test this locally (build the docs from my PR)? |
ef455d1
to
99d1ad8
Compare
Yes, go to the projects/coding-standard folder in your doctrine-website clone and checkout your clone & branch. Run |
99d1ad8
to
2428e12
Compare
docs/en/reference/customizing.rst
Outdated
<!-- set soft line length limit to 120 characters --> | ||
<property name="lineLimit" value="120"/> | ||
<!-- set hard line length limit to 120 characters --> | ||
<property name="absoluteLineLimit" value="160"/> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mismatch to documentation (120 vs. 160)
docs/en/reference/customizing.rst
Outdated
Adding new rules | ||
---------------- | ||
|
||
Add new rules is simple, all you need to do is add a new ``<rule>`` block: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adding
docs/en/reference/index.rst
Outdated
Project-level ruleset | ||
===================== | ||
|
||
To enable Doctrine Coding Standard for your project, create ``phpcs.xml.dist`` file with the following content: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"create a"
docs/en/reference/index.rst
Outdated
<file>lib</file> | ||
<file>tests</file> | ||
|
||
<!-- Include whole Doctrine Coding Standard --> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"whole" => "full|the whole"
2428e12
to
fa12b40
Compare
fa12b40
to
059fe5e
Compare
🚢 |
phpcs.xml(.dist)?
@jwage Can you please proofread this? Thanks.