phpDocumentor / phpDocumentor/ReflectionDocBlock
Add more information when an InvalidTag occurs and a link to the phpDocumentor documentation
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- PHP
- Estrellas
- 9.4k
- Forks
- 137
- Merge medio
- 4 d 2 h
- PR fusionados (30 d)
- 1
Descripción
In issue https://github.com/phpDocumentor/phpDocumentor/issues/3378, there was some confusion because the Author tag does not support a description. When the StandardTagFactory encounters a situation where an InvalidTag is generated, it would be nice if it could ask the Tag class what the expected format is and a link to the documentation; and include that in the InvalidTag so that phpDocumentor can provide better error messages in the error report
Guía de contribución
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
Empieza leyendo StandardTagFactory, InvalidTag y el comportamiento de la clase Tag descrito en el issue; después, revisa la discusión relacionada en el issue 3378. Se considera terminado cuando las instancias de InvalidTag incluyen el formato de tag esperado y un enlace a la documentación relevante de phpDocumentor, para que los informes de errores proporcionen indicaciones más claras.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- php
- Área
- documentation
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 45/100