Skip to content

Generic/LanguageConstructSpacing: add XML documentation #177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 3, 2024
Merged

Generic/LanguageConstructSpacing: add XML documentation #177

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3835a87
Generic/LanguageConstructSpacing: add XML documentation
rodrigoprimo Dec 20, 2023
7bd7325
LanguageConstructSpacing: improve sniff description in the documentation
rodrigoprimo Jan 2, 2024
dac279d
LanguageConstructSpacing: improve doc by adding `yield from` examples
rodrigoprimo Jan 2, 2024
fd07930
Improve LanguageConstructSpacing description in the docs
rodrigoprimo Jan 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions src/Standards/Generic/Docs/WhiteSpace/LanguageConstructSpacingStandard.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<documentation title="Language Construct Spacing">
<standard>
<![CDATA[
Language constructs that can be used without parentheses must contain a single space between themselves and their content.
]]>
</standard>
<code_comparison>
<code title="Valid: Single space after language construct.">
<![CDATA[
echo<em> </em>'Hello, World!';
throw<em> </em>new<em> </em>Exception();
return<em> </em>$newLine;
]]>
</code>
<code title="Invalid: No space, more than one space or newline after language construct.">
<![CDATA[
echo<em></em>'Hello, World!';
throw<em> </em>new<em> </em>Exception();
return<em></em>
$newLine;
]]>
</code>
</code_comparison>
<standard>
<![CDATA[
A single space must be used between the "yield" and "from" keywords for a "yield from" expression.
]]>
</standard>
<code_comparison>
<code title="Valid: Single space between yield and from.">
<![CDATA[
yield<em> </em>from [1, 2, 3];
]]>
</code>
<code title="Invalid: No space, more than one space or newline between yield and from.">
<![CDATA[
yield<em></em>from [1, 2, 3];
yield<em> </em>from [1, 2, 3];
yield<em></em>
from [1, 2, 3];
]]>
</code>
</code_comparison>
</documentation>