📚 Documentation: App class documentation is not up to date

Abierto
#91 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
48/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
php
Área
documentation

Línea de trabajo

Compare README.md and Getting-Starting-Guide.md with the current App class behavior, focusing on the documented hook types and init parameters. Update both documents so they describe the current API accurately, then verify that the outdated three-hook and parameter descriptions are gone.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

💭 Description

Both the README.md file and the Getting-Starting-Guide.md file suggests that there are 3 types of hooks, and that the parameters for the init hook for example are a callback function, a resources array, and a group.

However, this has not been the case for the past 2 years.

Documentation should be updated.

👀 Have you spent some time to check if this issue has been raised before?
  • I checked and didn't find similar issue
🏢 Have you read the Code of Conduct?
Lenguaje dominante
PHP
Estrellas
297
Forks
34
Sin PR fusionados en 30 d

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de utopia-php/http

Todos los issues de utopia-php/http

Issues similares

Más issues de PHP

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.