Bug #64850 [Opn]: Extra whitespace before function links
| From: | salathe@php.net | Date: | Wed, 15 May 2013 21:46:33 +0000 |
| Subject: | Bug #64850 [Opn]: Extra whitespace before function links | ||
| References: | 1 | Groups: | php.doc.bugs |
| Request: | Send a blank email to doc-bugs+get-9826@lists.php.net to get a copy of this message | ||
Edit report at https://bugs.php.net/bug.php?id=64850&edit=1
ID: 64850
Updated by: salathe@php.net
Reported by: salathe@php.net
Summary: Extra whitespace before function links
Status: Open
Type: Bug
Package: Doc Build problem
PHP Version: Irrelevant
Block user comment: N
Private report: N
New Comment:
Quick patch submitted as Pull Request: https://github.com/php/phd/pull/2
Previous Comments:
------------------------------------------------------------------------
[2013-05-15 21:35:42] salathe@php.net
Description:
------------
When rendering <function> tags, a space is added before the anchor tag.
This was a deliberate choice (see comment below) but affects areas other
than the function/method synopsis.
The Package_PHP_XHTML::format_function() method says:
// Leading space intional for methodname as phpdoc doesn't have a
// space between <type> and the <methodname> in methodsynopsis
However, this affects other uses of <methodname> and <function> and is
particularly noticeable when the function name is written in parentheses.
Examples:
mysql_pconnect:
"for future use ( mysql_close() will not close links"
mysqlnd.stats:
"from COM_LIST_FIELD ( mysql_list_fields()) and the"
ldap_control_paged_results:
"sent by the server ( ldap_control_paged_result_response())."
The leading space should be removed. Instead, a space should be added
to the rendered HTML only where it is needed: after rendering the
<type>, before a <methodname>, in a <methodsynopsis>.
------------------------------------------------------------------------
--
Edit this bug report at https://bugs.php.net/bug.php?id=64850&edit=1