Fix GH-80: Trim whitespace in tag content before link resolution#237
Open
lacatoire wants to merge 1 commit intophp:masterfrom
Open
Fix GH-80: Trim whitespace in tag content before link resolution#237lacatoire wants to merge 1 commit intophp:masterfrom
lacatoire wants to merge 1 commit intophp:masterfrom
Conversation
When <function>, <methodname>, <classname>, <varname>, <type>, or <enumidentifier> tags contain leading/trailing whitespace (e.g. from line breaks in translated documentation), link resolution fails because the lookup key includes the whitespace. Add trim() to all text handler functions that resolve links, ensuring whitespace does not break cross-reference linking.
Girgias
reviewed
Feb 15, 2026
| <div class="section"> | ||
| <p class="para">4. Varname with leading/trailing whitespace</p> | ||
| <p class="para"> | ||
| <var class="varname"><a href="reserved.variables.server.html" class="classname">_SERVER</a></var> |
Member
There was a problem hiding this comment.
Looks like a pre-existing issue, but this seems weird?
Suggested change
| <var class="varname"><a href="reserved.variables.server.html" class="classname">_SERVER</a></var> | |
| <var class="varname"><a href="reserved.variables.server.html" class="varname">_SERVER</a></var> |
|
|
||
| public function format_function_text($value) | ||
| { | ||
| $value = trim($value); |
Member
There was a problem hiding this comment.
I think it would be better if the XML source didn't contain those whitespaces.
So maybe add a global helper function that trims and checks if the trimmed and original value is the same, if not emit a rendering warning. So that in the long term we can fix the XML sources rather than handling this on the rendering side :)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
trim()to all text handler functions that resolve links (format_function_text,format_varname_text,format_classname_text,format_type_text,format_enumidentifier_text, and classsynopsis variants) in both PHP and PEAR XHTML packages<function>,<methodname>,<classname>,<varname>,<type>, or<enumidentifier>tags contain leading/trailing whitespace (e.g. from line breaks in translated documentation), link resolution was failing because the lookup key included the whitespace<function>,<methodname>,<classname>, and<varname>tags with whitespaceFixes #80