Skip to content

Commit 7b671a7

Browse files
committed
Docs: tweak markdown for compliance with markdownlint
1 parent 0c51e59 commit 7b671a7

File tree

2 files changed

+12
-15
lines changed

2 files changed

+12
-15
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Change Log for the PHPCSDevTools standard for PHP Codesniffer
1+
# Change Log for the PHPCSDevTools standard for PHP_CodeSniffer
22

33
All notable changes to this project will be documented in this file.
44

README.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
PHPCSDevTools for developers of PHP_CodeSniffer sniffs
2-
=====================================================
1+
# PHPCSDevTools for developers of PHP_CodeSniffer sniffs
32

43
<div aria-hidden="true">
54

@@ -34,8 +33,7 @@ This is a set of tools to assist developers of sniffs for [PHP CodeSniffer](http
3433
* [License](#license)
3534

3635

37-
Installation
38-
-------------------------------------------
36+
## Installation
3937

4038
### Composer Project-based Installation
4139

@@ -72,8 +70,7 @@ Composer will automatically install dependencies and register the PHPCSDebug sta
7270
```
7371

7472

75-
Features
76-
------------------------------
73+
## Features
7774

7875
### Checking whether all sniffs in a PHPCS standard are feature complete
7976

@@ -94,7 +91,7 @@ php -f "path/to/PHPCSDevTools/bin/phpcs-check-feature-completeness"
9491
If all is good, you will see a `All # sniffs are accompanied by unit tests and documentation.` message.
9592

9693
If there are files missing, you will see errors/warnings for each missing file, like so:
97-
```
94+
```text
9895
WARNING: Documentation missing for path/to/project/StandardName/Sniffs/Category/SniffNameSniff.php.
9996
ERROR: Unit tests missing for path/to/project/StandardName/Sniffs/Category/SniffNameSniff.php.
10097
```
@@ -105,7 +102,7 @@ phpcs-check-feature-completeness ./StandardName
105102
```
106103

107104
#### Options
108-
```
105+
```text
109106
directories One or more specific directories to examine.
110107
Defaults to the directory from which the script is run.
111108
-q, --quiet Turn off warnings for missing documentation.
@@ -143,7 +140,7 @@ phpcs ./SniffNameUnitTest.inc --standard=YourStandard,PHPCSDebug --sniffs=YourSt
143140
```
144141

145142
The output will look something along the lines of:
146-
```
143+
```text
147144
Ptr | Ln | Col | Cond | ( #) | Token Type | [len]: Content
148145
-------------------------------------------------------------------------
149146
0 | L1 | C 1 | CC 0 | ( 0) | T_OPEN_TAG | [ 5]: <?php
@@ -174,7 +171,7 @@ Ptr | Ln | Col | Cond | ( #) | Token Type | [len]: Content
174171
21 | L5 | C 6 | CC 0 | ( 0) | T_WHITESPACE | [ 0]:
175172
```
176173

177-
PHPCS itself can also display similar information using the `-vv` or `-vvv` verbosity flags, however, when using those, you will receive a *lot* more information than just the token list and, while useful for debugging PHPCS itself, the additional information is mostly just noise when developing a sniff.
174+
PHPCS itself can also display similar information using the `-vv` or `-vvv` verbosity flags, however, when using those, you will receive a _lot_ more information than just the token list and, while useful for debugging PHPCS itself, the additional information is mostly just noise when developing a sniff.
178175

179176
### Documentation XSD Validation
180177

@@ -229,12 +226,12 @@ jobs:
229226

230227
:point_right: You'll need to replace the `YourRuleset` within the command with the name of your ruleset (of course).
231228

232-
Contributing
233-
-------
229+
## Contributing
230+
234231
Contributions to this project are welcome. Clone this repository, branch off from `develop`, make your changes, commit them and send in a pull request.
235232

236233
If unsure whether the changes you are proposing would be welcome, open an issue first to discuss your proposal.
237234

238-
License
239-
-------
235+
## License
236+
240237
This code is released under the [GNU Lesser General Public License (LGPLv3)](http://www.gnu.org/copyleft/lesser.html).

0 commit comments

Comments
 (0)