cake 5: Support parameters with only type hints

Aperta
#198 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
php
Ambito
documentation

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.

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?

image

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).

Lingua principale
PHP
Stelle
29
Fork
15
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di cakephp/cakephp-api-docs

Tutte le issue di cakephp/cakephp-api-docs

Issue simili

Altre issue su PHP

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.