cakephp / cakephp/cakephp-api-docs
cake 5: Support parameters with only type hints
Personne n'a encore pris cette issue.
- Langage dominant
- PHP
- Étoiles
- 29
- Forks
- 15
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
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).
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par examiner comment les paramètres de CakePHP 5 avec des déclarations de type PHP 8 sont représentés dans la documentation de l’API. Déterminez si les paramètres sans annotations @param correspondantes doivent apparaître avec des descriptions vides ou être masqués, puis ajoutez une couverture pour le comportement retenu.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- php
- Domaine
- documentation
- Type d'issue
- Fonctionnalité
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 35/100