cakephp / cakephp/cakephp-api-docs
API Docs Links appear broken
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
Description
Viewing API Documentation on the web, e.g. RecordNotFoundException, shows the raw link string instead of an actual hyperlink, e.g.:
Array of headers to be passed to {@link \Cake\Http\Response::withHeader()}
It doesn't seem that the files containing the links are the issue, e.g. CakeException.php hasn't changed in ~two years, perhaps the docs builder/link generator has started failing?
CakePHP Version
4.4.0
PHP Version
No response
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
Comparez la page d’API générée pour RecordNotFoundException avec la référence source dans CakeException.php, en particulier le texte {@link \Cake\Http\Response::withHeader()}. Suivez le générateur de documentation ou de liens chargé de convertir ces références, puis vérifiez que la documentation d’API générée les affiche sous forme d’hyperliens plutôt que de chaînes brutes.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- php
- Domaine
- documentation
- Type d'issue
- Bug
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100