WordPress / WordPress/phpdoc-parser
Improve default content function
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 239
- Forks
- 81
- Avg merge
- 16h 29m
- Merged PRs (30d)
- 8
Description
While expand_content() can be dropped by developers in favour of a custom output, the default function should still be improved.
It is currently very focused towards how functions look, and not classes and hooks. For instance, the prototype doesn't make a lot of sense of classes or hooks.
The Arguments heading is output regardless of whether there are any argument or not.
The function name itself is also a little too generic - wpfuncref_content() might be better for instance.
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
Locate expand_content() and its default output path, then compare how it formats functions with the expected needs of classes and hooks. Check the handling of the Arguments heading and the proposed wpfuncref_content() name. Done means the default content is appropriate for these element types, omits empty sections, and has an agreed function name.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100