Skip to content

Commit a0d46f4

Browse files
committed
Squiz/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 51903d7 commit a0d46f4

File tree

6 files changed

+15
-15
lines changed

6 files changed

+15
-15
lines changed

src/Standards/Squiz/Docs/Arrays/ArrayDeclarationStandard.xml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@
1010
]]>
1111
</standard>
1212
<code_comparison>
13-
<code title="Valid: array keyword lowercase">
13+
<code title="Valid: Array keyword lowercase.">
1414
<![CDATA[
1515
$array = array('val1', 'val2');
1616
]]>
1717
</code>
18-
<code title="Invalid: first letter capitalised">
18+
<code title="Invalid: First letter capitalised.">
1919
<![CDATA[
2020
$array = Array('val1', 'val2');
2121
]]>
@@ -27,15 +27,15 @@ $array = Array('val1', 'val2');
2727
]]>
2828
</standard>
2929
<code_comparison>
30-
<code title="Valid: first key on second line">
30+
<code title="Valid: First key on second line.">
3131
<![CDATA[
3232
$array = array(
3333
'key1' => 'value1',
3434
'key2' => 'value2',
3535
);
3636
]]>
3737
</code>
38-
<code title="Invalid: first key on same line">
38+
<code title="Invalid: First key on same line.">
3939
<![CDATA[
4040
$array = array('key1' => 'value1',
4141
'key2' => 'value2',
@@ -49,15 +49,15 @@ $array = array('key1' => 'value1',
4949
]]>
5050
</standard>
5151
<code_comparison>
52-
<code title="Valid: aligned correctly">
52+
<code title="Valid: Aligned correctly.">
5353
<![CDATA[
5454
$array = array(
5555
<em> </em>'key1' => 'value1',
5656
<em> </em>'key2' => 'value2',
5757
);
5858
]]>
5959
</code>
60-
<code title="Invalid: keys and parenthesis aligned incorrectly">
60+
<code title="Invalid: Keys and parenthesis aligned incorrectly.">
6161
<![CDATA[
6262
$array = array(
6363
<em>'</em>key1' => 'value1',
@@ -72,15 +72,15 @@ $array = array(
7272
]]>
7373
</standard>
7474
<code_comparison>
75-
<code title="Valid: keys and values aligned">
75+
<code title="Valid: Keys and values aligned.">
7676
<![CDATA[
7777
$array = array(
7878
'keyTen'<em> </em>=> 'ValueTen',
7979
'keyTwenty'<em> </em>=> 'ValueTwenty',
8080
);
8181
]]>
8282
</code>
83-
<code title="Invalid: alignment incorrect">
83+
<code title="Invalid: Alignment incorrect.">
8484
<![CDATA[
8585
$array = array(
8686
'keyTen'<em> </em>=> 'ValueTen',
@@ -95,7 +95,7 @@ $array = array(
9595
]]>
9696
</standard>
9797
<code_comparison>
98-
<code title="Valid: comma after each value">
98+
<code title="Valid: Comma after each value.">
9999
<![CDATA[
100100
$array = array(
101101
'key1' => 'value1',
@@ -104,7 +104,7 @@ $array = array(
104104
);
105105
]]>
106106
</code>
107-
<code title="Invalid: no comma after last value">
107+
<code title="Invalid: No comma after last value.">
108108
<![CDATA[
109109
$array = array(
110110
'key1' => 'value1',

src/Standards/Squiz/Docs/Classes/LowercaseClassKeywordsStandard.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<documentation title="Lowercase Class Keywords">
22
<standard>
33
<![CDATA[
4-
The php keywords class, interface, trait, extends, implements, abstract, final, var, and const should be lowercase.
4+
The PHP keywords class, interface, trait, extends, implements, abstract, final, var, and const should be lowercase.
55
]]>
66
</standard>
77
<code_comparison>

src/Standards/Squiz/Docs/ControlStructures/LowercaseDeclarationStandard.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<documentation title="Lowercase Control Structure Keywords">
22
<standard>
33
<![CDATA[
4-
The php keywords if, else, elseif, foreach, for, do, switch, while, try, and catch should be lowercase.
4+
The PHP keywords if, else, elseif, foreach, for, do, switch, while, try, and catch should be lowercase.
55
]]>
66
</standard>
77
<code_comparison>

src/Standards/Squiz/Docs/Functions/LowercaseFunctionKeywordsStandard.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<documentation title="Lowercase Function Keywords">
22
<standard>
33
<![CDATA[
4-
The php keywords function, public, private, protected, and static should be lowercase.
4+
The PHP keywords function, public, private, protected, and static should be lowercase.
55
]]>
66
</standard>
77
<code_comparison>

src/Standards/Squiz/Docs/WhiteSpace/LanguageConstructSpacingStandard.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<documentation title="Language Construct Whitespace">
22
<standard>
33
<![CDATA[
4-
The php constructs echo, print, return, include, include_once, require, require_once, and new should have one space after them.
4+
The PHP constructs echo, print, return, include, include_once, require, require_once, and new should have one space after them.
55
]]>
66
</standard>
77
<code_comparison>

src/Standards/Squiz/Docs/WhiteSpace/ScopeKeywordSpacingStandard.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<documentation title="Scope Keyword Spacing">
22
<standard>
33
<![CDATA[
4-
The php keywords static, public, private, and protected should have one space after them.
4+
The PHP keywords static, public, private, and protected should have one space after them.
55
]]>
66
</standard>
77
<code_comparison>

0 commit comments

Comments
 (0)