Skip to content

Clarify heredoc indentation rules and examples in PHP #5762

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

Closed
AlwaysVictorious wants to merge 2 commits into from
Closed

Clarify heredoc indentation rules and examples in PHP #5762

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
976ae3c
Clarify heredoc indentation in PHP example
AlwaysVictorious Aug 14, 2026
80182d0
Update indentation rules and examples in string.xml
AlwaysVictorious Aug 14, 2026
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
33 changes: 17 additions & 16 deletions language/types/string.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,8 +216,9 @@
</simpara>

<simpara>
The closing identifier may be indented by space or tab, in which case
the indentation will be stripped from all lines in the doc string.
The closing identifier may be indented with spaces or tabs. Whitespace
equal to the closing identifier's indentation is then removed from the
beginning of every line in the doc string.
Prior to PHP 7.3.0, the closing identifier <emphasis>must</emphasis>
begin in the first column of the line.
</simpara>
Expand All @@ -233,20 +234,20 @@
<programlisting role="php">
<![CDATA[
<?php
// no indentation
// closing identifier not indented
echo <<<END
a
b
c
\n
END;

// 4 spaces of indentation

Check failure on line 244 in language/types/string.xml

View workflow job for this annotation

GitHub Actions / DocBook Style Check (en) 

string.xml: Trailing whitespace detected.
// closing identifier indented with 3 spaces; 3 spaces stripped from each line
echo <<<END
a
b
c
END;
END;
]]>
</programlisting>
&example.outputs.73;
Expand All @@ -256,9 +257,9 @@
b
c

a
b
c
a
b
c
]]>
</screen>
</example>
Expand Down Expand Up @@ -308,23 +309,23 @@

// different indentation for body (spaces) and ending marker (tabs)
{
echo <<<END
a
END;
echo <<<END
a
END;
}

// mixing spaces and tabs in body
{
echo <<<END
a
a
END;
}

// mixing spaces and tabs in ending marker
{
echo <<<END
a
END;
echo <<<END
a
END;
}
]]>
</programlisting>
Expand Down
Loading