Skip to content

Generic/FunctionCallArgumentSpacing: improve XML documentation #923

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 3 commits into from
Apr 3, 2025
Merged

Generic/FunctionCallArgumentSpacing: improve XML documentation #923

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a80fde9
Generic/FunctionCallArgumentSpacing: update XML doc to remove info ab…
rodrigoprimo Apr 2, 2025
7a47e82
Generic/FunctionCallArgumentSpacing: fix code examples in the XML doc
rodrigoprimo Apr 2, 2025
02ff468
Generic/FunctionCallArgumentSpacing: improve XML documentation
rodrigoprimo Apr 2, 2025
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
32 changes: 6 additions & 26 deletions src/Standards/Generic/Docs/Functions/FunctionCallArgumentSpacingStandard.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,38 +1,18 @@
<documentation title="Function Argument Spacing">
<documentation title="Function Call Argument Spacing">
<standard>
<![CDATA[
Function arguments should have one space after a comma, and single spaces surrounding the equals sign for default values.
There should be no space before and exactly one space, or a new line, after a comma when passing arguments to a function or method.
]]>
</standard>
<code_comparison>
<code title="Valid: Single spaces after a comma.">
<code title="Valid: No space before and exactly one space after a comma.">
<![CDATA[
function foo($bar,<em> </em>$baz)
{
}
foo($bar,<em> </em>$baz);
]]>
</code>
<code title="Invalid: No spaces after a comma.">
<code title="Invalid: A space before and no space after a comma.">
<![CDATA[
function foo($bar,<em></em>$baz)
{
}
]]>
</code>
</code_comparison>
<code_comparison>
<code title="Valid: Single spaces around an equals sign in function declaration.">
<![CDATA[
function foo($bar, $baz<em> </em>=<em> </em>true)
{
}
]]>
</code>
<code title="Invalid: No spaces around an equals sign in function declaration.">
<![CDATA[
function foo($bar, $baz<em></em>=<em></em>true)
{
}
foo($bar<em> </em>,<em></em>$baz);
]]>
</code>
</code_comparison>
Expand Down