cakephp / cakephp/cakephp-api-docs
cake 5: Support parameters with only type hints
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- PHP
- Sterne
- 29
- Forks
- 15
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
Starting with cake 5, some function parameters won't have matching docblock @param annotations.
Do we want to still list these parameters in the parameter block with no description or should we hide them?
These parameters won't have a matching annotation because PHP 8 allows union types that fully documents the allowed types and the parameter name is self-documenting (the annotation description isn't helpful).
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
Beginnen Sie damit zu überprüfen, wie CakePHP 5-Parameter mit PHP 8-Typdeklarationen in der API-Dokumentation dargestellt werden. Klären Sie, ob Parameter ohne passende @param-Annotationen mit leeren Beschreibungen erscheinen oder ausgeblendet werden sollen, und fügen Sie anschließend Testabdeckung für das ausgewählte Verhalten hinzu.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- php
- Bereich
- documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 35/100