Doc #61061 [Opn->Ver]: mb_decode_numericentity() description is very confusing

From: Date: Thu, 18 Mar 2021 23:41:52 +0000
Subject: Doc #61061 [Opn->Ver]: mb_decode_numericentity() description is very confusing
References: 1  Groups: php.doc.bugs 
Request: Send a blank email to doc-bugs+get-18657@lists.php.net to get a copy of this message
Edit report at https://bugs.php.net/bug.php?id=61061&edit=1

 ID:                 61061
 Updated by:         cmb@php.net
 Reported by:        matteosistisette at gmail dot com
 Summary:            mb_decode_numericentity() description is very
                     confusing
-Status:             Open
+Status:             Verified
 Type:               Documentation Problem
 Package:            mbstring related
 PHP Version:        Irrelevant
 Block user comment: N
 Private report:     N

 New Comment:

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

I think that should be "numeric entity references in $string".

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

I think that refers to the $map parameter, but wouldn't know
the details.


Previous Comments:
------------------------------------------------------------------------
[2012-02-12 20:06:42] matteosistisette at gmail dot com

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 this bug report at https://bugs.php.net/bug.php?id=61061&edit=1


Thread (3 messages)

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