File tree Expand file tree Collapse file tree 1 file changed +6
-3
lines changed Expand file tree Collapse file tree 1 file changed +6
-3
lines changed Original file line number Diff line number Diff line change @@ -154,13 +154,15 @@ phpcs-check-doc-examples
154154php path/to/PHPCSDevTools/bin/phpcs-check-doc-examples
155155```
156156
157- If all is good, the script will exit with code 0 and no output .
157+ If all is good, the script will exit with code 0 and a summary of what was checked .
158158
159159If there are issues with the code examples, you will see error messages for each problematic example, like so:
160160``` text
161161Errors found while processing path/to/project/StandardName/Docs/Category/SniffNameStandard.xml:
162- - Invalid example #1 does not trigger any errors, but it should.
163- - Valid example #2 triggers errors, but it shouldn't.
162+
163+ ERROR: Code block is valid and PHPCS should have returned nothing, but instead it returned an error.
164+ Code block title: "Valid: invalid valid code example."
165+ Code block content: "function sniffValidationWillFail() {}"
164166```
165167
166168#### Options
@@ -171,6 +173,7 @@ directories|files One or more specific directories or files to exa
171173 exclude from the scan.
172174--ignore-sniffs=<sniff1,sniff2> Comma-delimited list of sniffs to ignore.
173175--help Print the script help page.
176+ -V, --version Display the current version of this script.
174177```
175178
176179### Sniff Debugging
You can’t perform that action at this time.
0 commit comments