Skip to content

Commit 9e0b685

Browse files
committed
PEAR/Documentation: minor consistency fixes
* Verified that the contents of `<standard>` elements is consistently indented (with four spaces). * Verified that all `<code>` `title` attributes use proper capitalization and punctuation and are prefixed with "Valid" or "Invalid".
1 parent 74aaaf1 commit 9e0b685

File tree

7 files changed

+14
-14
lines changed

7 files changed

+14
-14
lines changed

src/Standards/PEAR/Docs/Commenting/FileCommentStandard.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<documentation title="File Comments">
22
<standard>
33
<![CDATA[
4-
Files must have a non-empty doc comment. The short description must be on the second line of the comment. Each description must have one blank comment line before and after. There must be one blank line before the tags in the comments. There must be a category, package, author, license, and link tag. There may only be one category, package, subpackage, license, version, since and deprecated tag. The tags must be in the order category, package, subpackage, author, copyright, license, version, link, see, since, and deprecated. The php version must be specified.
4+
Files must have a non-empty doc comment. The short description must be on the second line of the comment. Each description must have one blank comment line before and after. There must be one blank line before the tags in the comments. There must be a category, package, author, license, and link tag. There may only be one category, package, subpackage, license, version, since and deprecated tag. The tags must be in the order category, package, subpackage, author, copyright, license, version, link, see, since, and deprecated. The PHP version must be specified.
55
]]>
66
</standard>
77
<code_comparison>
@@ -267,7 +267,7 @@
267267
*/
268268
]]>
269269
</code>
270-
<code title="Invalid: No php version specified.">
270+
<code title="Invalid: No PHP version specified.">
271271
<![CDATA[
272272
<?php
273273
/**

src/Standards/PEAR/Docs/Files/IncludingFileStandard.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@
1010
]]>
1111
</standard>
1212
<code_comparison>
13-
<code title="Valid: used as statement">
13+
<code title="Valid: Used as statement.">
1414
<![CDATA[
1515
require_once 'PHP/CodeSniffer.php';
1616
]]>
1717
</code>
18-
<code title="Invalid: used as function">
18+
<code title="Invalid: Used as function.">
1919
<![CDATA[
2020
require_once<em>(</em>'PHP/CodeSniffer.php'<em>)</em>;
2121
]]>

src/Standards/PEAR/Docs/Functions/FunctionCallSignatureStandard.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
<documentation title="Function Calls">
22
<standard>
33
<![CDATA[
4-
Functions should be called with no spaces between the function name, the opening parenthesis, and the first parameter; and no space between the last parameter, the closing parenthesis, and the semicolon.
4+
Functions should be called with no spaces between the function name, the opening parenthesis, and the first parameter; and no space between the last parameter, the closing parenthesis, and the semicolon.
55
]]>
66
</standard>
77
<code_comparison>
8-
<code title="Valid: spaces between parameters">
8+
<code title="Valid: Spaces between parameters.">
99
<![CDATA[
1010
$var = foo($bar, $baz, $quux);
1111
]]>
1212
</code>
13-
<code title="Invalid: additional spaces used">
13+
<code title="Invalid: Additional spaces used.">
1414
<![CDATA[
1515
$var = foo<em> </em>(<em> </em>$bar, $baz, $quux<em> </em>)<em> </em>;
1616
]]>

src/Standards/PEAR/Docs/Functions/ValidDefaultValueStandard.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@
55
]]>
66
</standard>
77
<code_comparison>
8-
<code title="Valid: argument with default value at end of declaration">
8+
<code title="Valid: Argument with default value at end of declaration.">
99
<![CDATA[
1010
function connect($dsn, <em>$persistent = false</em>)
1111
{
1212
...
1313
}
1414
]]>
1515
</code>
16-
<code title="Invalid: argument with default value at start of declaration">
16+
<code title="Invalid: Argument with default value at start of declaration.">
1717
<![CDATA[
1818
function connect(<em>$persistent = false</em>, $dsn)
1919
{

src/Standards/PEAR/Docs/NamingConventions/ValidClassNameStandard.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55
]]>
66
</standard>
77
<code_comparison>
8-
<code title="Examples of valid class names">
8+
<code title="Valid: Examples of valid class names.">
99
<![CDATA[
1010
Log
1111
Net_Finger
1212
HTML_Upload_Error
1313
]]>
1414
</code>
15-
<code title="Examples of invalid class names">
15+
<code title="Invalid: Examples of invalid class names.">
1616
<![CDATA[
1717
log
1818
NetFinger

src/Standards/PEAR/Docs/NamingConventions/ValidFunctionNameStandard.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@
55
]]>
66
</standard>
77
<code_comparison>
8-
<code title="Examples of valid function names">
8+
<code title="Valid: Examples of valid function names.">
99
<![CDATA[
1010
connect()
1111
getData()
1212
buildSomeWidget()
1313
XML_RPC_serializeData()
1414
]]>
1515
</code>
16-
<code title="Examples of invalid function names">
16+
<code title="Invalid: Examples of invalid function names.">
1717
<![CDATA[
1818
Connect()
1919
get_data()

src/Standards/PEAR/Docs/NamingConventions/ValidVariableNameStandard.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ class Foo
1515
}
1616
]]>
1717
</code>
18-
<code title="Invalid: underscores used on public/protected variables and not used on private variables.">
18+
<code title="Invalid: Underscores used on public/protected variables and not used on private variables.">
1919
<![CDATA[
2020
class Foo
2121
{

0 commit comments

Comments
 (0)