cakephp / cakephp/cakephp-api-docs
Web site API reference lacks extended class and implemented interfaces...
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 29
- Forks
- 15
- PR merge metrics
- No merged PRs in 30d
Description
Description
I feel strange because I can't believe I can't find it...
I pick up just an example. I was trying to understand what Cake\ORM\ResultSet actually is. Easy to guess by the scope and the name (and the methods). But, apart from that, commonly I am used to find reference to extended class and implemented interfaces in API reference documentations. For CakePHP I have to open the source code link.
Example: Cake\ORM\ResultSet.
CakePHP Version
5.2
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 Cake\ORM\ResultSet API reference page linked in the issue and compare it with the linked source code. Trace how the API reference is generated, then ensure the extended class and implemented interfaces are displayed on the page and verify the generated output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100