ArrayIterator documentation is unclear
Nobody has claimed this yet.
- Dominant language
- XML
- Stars
- 596
- Forks
- 890
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 55
Description
From https://www.php.net/manual/en/class.arrayiterator.php
When you want to iterate over the same array multiple times you need to instantiate ArrayObject and let it create ArrayIterator instances that refer to it either by using foreach or by calling its getIterator() method manually.
I don't get it. This talks about ArrayObject on the ArrayIterator page. But what if I want to use ArrayIterator directly? It's possible to use it directly without any involvement of ArrayObject.
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
Start with the ArrayIterator manual page at the linked php.net URL and read the quoted paragraph alongside the ArrayObject and getIterator() references. Clarify how ArrayIterator can be used directly and revise the confusing wording so the page accurately explains when ArrayObject is relevant; verify the rendered documentation afterward.
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
- 52/100