cakephp / cakephp/cakephp-api-docs
API Docs Links appear broken
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- PHP
- Estrellas
- 29
- Forks
- 15
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
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
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Compara la página de API generada para RecordNotFoundException con la referencia de origen en CakeException.php, especialmente el texto {@link \Cake\Http\Response::withHeader()}. Rastrea el generador de documentación o de enlaces responsable de convertir estas referencias y, a continuación, verifica que la documentación de API generada las renderice como hipervínculos en lugar de cadenas sin procesar.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- php
- Área
- documentation
- Tipo de issue
- Error
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 45/100