WordPress / WordPress/phpdoc-parser
Parse global variables
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 239
- Forks
- 81
- Avg merge
- 16h 29m
- Merged PRs (30d)
- 8
Description
Definitely an under-documented portion of core. On the other hand, WP is moving away from using globals, and I'm not sure if many of them are actually documented inline anywhere. So although I'd like to see this added, I understand that it isn't going to be a priority.
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
No file, test, or entry point is named. Start by surveying how the documentation parser handles core inline documentation and global variables, then establish which globals are in scope and how they should be represented; done would mean those agreed globals are parsed and covered by validation, but the issue does not define that scope.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100