cakephp / cakephp/cakephp-api-docs
Web site API reference lacks extended class and implemented interfaces...
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- PHP
- Sterne
- 29
- Forks
- 15
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der im Issue verlinkten Cake\ORM\ResultSet API-Referenzseite und vergleiche sie mit dem verlinkten Quellcode. Verfolge, wie die API-Referenz generiert wird, stelle dann sicher, dass die erweiterte Klasse und die implementierten Schnittstellen auf der Seite angezeigt werden, und überprüfe die generierte Ausgabe.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- php
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100