Skip to content

Commit bf0e337

Browse files
committed
XSD: minor touch up
1 parent 5d491b6 commit bf0e337

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

PHPCSDebug/Docs/Debug/TokenListStandard.xml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
<documentation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://phpcsstandards.github.io/PHPCSDevTools/phpcsdocs.xsd" title="Token List">
1+
<?xml version="1.0"?>
2+
<documentation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3+
xsi:noNamespaceSchemaLocation="https://phpcsstandards.github.io/PHPCSDevTools/phpcsdocs.xsd"
4+
title="Token List"
5+
>
26
<standard>
37
<![CDATA[
48
Lists how PHPCS tokenizes code.

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -184,17 +184,17 @@ In order to use it, you'll need to add the schema related attributes to the `doc
184184

185185
```xml
186186
<documentation
187-
title="Name of the sniff"
188187
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
189188
xsi:noNamespaceSchemaLocation="https://phpcsstandards.github.io/PHPCSDevTools/phpcsdocs.xsd"
189+
title="Name of the sniff"
190190
>
191191
```
192192

193193
If your IDE or editor supports automatic validation of XML files, you will be notified if your documentation XML file has the correct number of elements, correct type and number of certain attributes, and title length among other things.
194194

195195
#### Validating your docs against the XSD
196196

197-
You can validate your PHPCS XML documentation against the XSD file using [xmllint](https://gnome.pages.gitlab.gnome.org/libxml2/xmllint.html). This validation can be run locally if you have xmllint installed, as well as in CI (continuous integration).
197+
You can validate your PHPCS XML documentation against the XSD file using [xmllint](http://xmlsoft.org/xmllint.html). This validation can be run locally if you have xmllint installed, as well as in CI (continuous integration).
198198

199199
An example of a workflow job for GitHub Actions CI looks like this:
200200

@@ -217,7 +217,7 @@ jobs:
217217
run: xmllint --noout --schema vendor/phpcsstandards/phpcsdevtools/DocsXsd/phpcsdocs.xsd ./YourRuleset/Docs/**/*Standard.xml
218218
```
219219
220-
You'd need to replace the `YourRuleset` with the name of your ruleset of course.
220+
:point_right: You'll need to replace the `YourRuleset` within the command with the name of your ruleset (of course).
221221

222222
Contributing
223223
-------

0 commit comments

Comments
 (0)