Small issues with mb_convert_* documentation
Nobody has claimed this yet.
- Dominant language
- XML
- Stars
- 596
- Forks
- 890
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 55
Description
- mb_convert_encoding()
to_encoding and from_encoding mentions "type of coding" and "character code" while it should be just "encoding" or "character encoding". It might be confusing.
- mb_convert_variables()
from_encoding mentions non-existing from-coding label. Also, the argument description could be written better. Last, but not least, in "When from_encoding is omitted, detect_order is used.", how it can be omitted if the argument type is array|string? I think it could be clarified.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Search the PHP documentation entries for mb_convert_encoding() and mb_convert_variables(), then review the to_encoding and from_encoding descriptions. Clarify the encoding terminology, fix the missing from-coding label, improve the argument wording, and explain how from_encoding may be omitted despite its listed type.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 62/100