Skip to content

Commit 2008c45

Browse files
committed
Annotated-Ruleset: minor tweaks
1 parent 6f7f332 commit 2008c45

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

wiki/Annotated-Ruleset.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
PHP_CodeSniffer allows developers to design their own coding standards by creating a simple ruleset XML file that both pulls in sniffs from existing standards and customises them for the developer's needs. This XML file can be named anything you like, as long as it has an `xml` extension and complies to the ruleset.xml format. The file can be stored anywhere, making it perfect for placing under version control with a project's source code and unit tests.
22

3-
Once created, a ruleset file can be used with the `--standard` command line argument. In the following example, PHP_CodeSniffer will use the coding standard defined in a custom ruleset file called custom_ruleset.xml:
3+
Once created, a ruleset file can be used with the `--standard` command line argument. In the following example, PHP_CodeSniffer will use the coding standard defined in a custom ruleset file called `custom_ruleset.xml`:
44

55
```bash
66
$ phpcs --standard=/path/to/custom_ruleset.xml test.php
@@ -14,7 +14,7 @@ For projects, it is recommended to use one of the `.dist` filenames.
1414

1515
## The Annotated Sample File
1616

17-
The following sample file documents the ruleset.xml format and shows you the complete range of features that the format supports. The file is designed for documentation purposes only and is not a working coding standard.
17+
The following sample file documents the `ruleset.xml` format and shows you the complete range of features that the format supports. The file is designed for documentation purposes only and is not a working coding standard.
1818

1919
```xml
2020
<?xml version="1.0"?>
@@ -446,7 +446,7 @@ Setting the `phpcs-only` attribute to `true` will only apply the rule when the `
446446

447447
Setting the `phpcbf-only` attribute to `true` will only apply the rule when the `phpcbf` tool is fixing a file. The rule will not be applied while the file is being checked with the `phpcs` tool.
448448

449-
The following sample file shows a ruleset.xml file that makes use of selective rules. The file is designed for documentation purposes only and is not a working coding standard.
449+
The following sample file shows a `ruleset.xml` file that makes use of selective rules. The file is designed for documentation purposes only and is not a working coding standard.
450450

451451
```xml
452452
<?xml version="1.0"?>

0 commit comments

Comments
 (0)