SplPriorityQueue::getExtractFlags() is flagged as undocumented
Nobody has claimed this yet.
- Dominant language
- XML
- Stars
- 596
- Forks
- 890
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 55
Description
The SplPriorityQueue::getExtractFlags() method is marked as undocumented, but it has no less documentation than any of the other methods. Should the flag be removed, or should the others have it added?
From what I can tell, the only thing missing is examples, which they are all missing. Is there a definition somewhere as to what constitutes "undocumented" or "underdocumented"? I've compiled a list (markdown and json) here of all things currently flagged as such.
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 by reviewing the documentation status for SplPriorityQueue::getExtractFlags() and compare it with the other SplPriorityQueue methods. Read the linked gist and look for the project's definition of “undocumented” or “underdocumented.” Done means reaching a clear decision about the flag and identifying the consistent documentation changes required.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100