cakephp / cakephp/cakephp-api-docs
cake 5: Support parameters with only type hints
Nessuno ha ancora preso questa issue.
- Lingua principale
- PHP
- Stelle
- 29
- Fork
- 15
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
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).
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia esaminando come vengono rappresentati nella documentazione dell’API i parametri di CakePHP 5 con dichiarazioni di tipo PHP 8. Determina se i parametri privi delle annotazioni @param corrispondenti debbano apparire con descrizioni vuote o essere nascosti, quindi aggiungi la copertura per il comportamento selezionato.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- php
- Ambito
- documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 35/100