Doc #61061 [NEW]: mb_decode_numericentity() description is very confusing

From: Date: Sun, 12 Feb 2012 20:06:42 +0000
Subject: Doc #61061 [NEW]: mb_decode_numericentity() description is very confusing
Groups: php.doc.bugs 
Request: Send a blank email to doc-bugs+get-7931@lists.php.net to get a copy of this message 
From:             
Operating system: 
PHP version:      Irrelevant
Package:          Documentation problem
Bug Type:         Documentation Problem
Bug description:mb_decode_numericentity() description is very confusing

Description:
------------
---
From manual page:
http://www.php.net/function.mb-decode-numericentity#refsect1-
function.mb-decode-numericentity-description
---

The description:
""
string mb_decode_numericentity ( string $str , array $convmap , string
$encoding 
)
Convert numeric string reference of string str in a specified block to 
character.
""
is completely ununderstandable. 

First, it uses the singular "string reference [...] to character", which
seems 
to suggest that the function will only convert ONE html entity into ONE 
character, which is not so (it will convert all numeric html entities in
the 
given string to characters).

Second, it is not clear what "in a specified block" means.

Third, "numeric string reference of string str" is pretty confusing.

I'm not native english speaking but it looks like the person who wrote this
part 
of the documentation wasn't either.


-- 
Edit bug report at https://bugs.php.net/bug.php?id=61061&edit=1
-- 
Try a snapshot (PHP 5.4):            https://bugs.php.net/fix.php?id=61061&r=trysnapshot54
Try a snapshot (PHP 5.3):            https://bugs.php.net/fix.php?id=61061&r=trysnapshot53
Try a snapshot (trunk):              https://bugs.php.net/fix.php?id=61061&r=trysnapshottrunk
Fixed in SVN:                        https://bugs.php.net/fix.php?id=61061&r=fixed
Fixed in SVN and need be documented: https://bugs.php.net/fix.php?id=61061&r=needdocs
Fixed in release:                    https://bugs.php.net/fix.php?id=61061&r=alreadyfixed
Need backtrace:                      https://bugs.php.net/fix.php?id=61061&r=needtrace
Need Reproduce Script:               https://bugs.php.net/fix.php?id=61061&r=needscript
Try newer version:                   https://bugs.php.net/fix.php?id=61061&r=oldversion
Not developer issue:                 https://bugs.php.net/fix.php?id=61061&r=support
Expected behavior:                   https://bugs.php.net/fix.php?id=61061&r=notwrong
Not enough info:                     https://bugs.php.net/fix.php?id=61061&r=notenoughinfo
Submitted twice:                     https://bugs.php.net/fix.php?id=61061&r=submittedtwice
register_globals:                    https://bugs.php.net/fix.php?id=61061&r=globals
PHP 4 support discontinued:          https://bugs.php.net/fix.php?id=61061&r=php4
Daylight Savings:                    https://bugs.php.net/fix.php?id=61061&r=dst
IIS Stability:                       https://bugs.php.net/fix.php?id=61061&r=isapi
Install GNU Sed:                     https://bugs.php.net/fix.php?id=61061&r=gnused
Floating point limitations:          https://bugs.php.net/fix.php?id=61061&r=float
No Zend Extensions:                  https://bugs.php.net/fix.php?id=61061&r=nozend
MySQL Configuration Error:           https://bugs.php.net/fix.php?id=61061&r=mysqlcfg

Thread (3 messages)

« previous php.doc.bugs (#7931) next »