Skip to content

Commit 51903d7

Browse files
committed
PSR1/2/12/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 ede7510 commit 51903d7

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

src/Standards/PSR1/Docs/Files/SideEffectsStandard.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<documentation title="Side Effects">
22
<standard>
33
<![CDATA[
4-
A php file should either contain declarations with no side effects, or should just have logic (including side effects) with no declarations.
4+
A PHP file should either contain declarations with no side effects, or should just have logic (including side effects) with no declarations.
55
]]>
66
</standard>
77
<code_comparison>

src/Standards/PSR1/Docs/Methods/CamelCapsMethodNameStandard.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
]]>
66
</standard>
77
<code_comparison>
8-
<code title="Valid: method name in camelCase.">
8+
<code title="Valid: Method name in camelCase.">
99
<![CDATA[
1010
class Foo
1111
{
@@ -15,7 +15,7 @@ class Foo
1515
}
1616
]]>
1717
</code>
18-
<code title="Invalid: method name not in camelCase.">
18+
<code title="Invalid: Method name not in camelCase.">
1919
<![CDATA[
2020
class Foo
2121
{

src/Standards/PSR12/Docs/Functions/NullableTypeDeclarationStandard.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
]]>
66
</standard>
77
<code_comparison>
8-
<code title="Valid: no whitespace used.">
8+
<code title="Valid: No whitespace used.">
99
<![CDATA[
1010
public function functionName(
1111
?string $arg1,
@@ -14,7 +14,7 @@ public function functionName(
1414
}
1515
]]>
1616
</code>
17-
<code title="Invalid: superfluous whitespace used.">
17+
<code title="Invalid: Superfluous whitespace used.">
1818
<![CDATA[
1919
public function functionName(
2020
? string $arg1,
@@ -25,14 +25,14 @@ public function functionName(
2525
</code>
2626
</code_comparison>
2727
<code_comparison>
28-
<code title="Valid: no unexpected characters.">
28+
<code title="Valid: No unexpected characters.">
2929
<![CDATA[
3030
public function foo(?int $arg): ?string
3131
{
3232
}
3333
]]>
3434
</code>
35-
<code title="Invalid: unexpected characters used.">
35+
<code title="Invalid: Unexpected characters used.">
3636
<![CDATA[
3737
public function bar(? /* comment */ int $arg): ?
3838
// nullable for a reason

src/Standards/PSR2/Docs/Methods/MethodDeclarationStandard.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ class Foo
3737
}
3838
]]>
3939
</code>
40-
<code title="Invalid: static keyword used before visibility and final used after.">
40+
<code title="Invalid: `static` keyword used before visibility and final used after.">
4141
<![CDATA[
4242
class Foo
4343
{

0 commit comments

Comments
 (0)