📚 Documentation: App class documentation is not up to date

Aperta
#91 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
48/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
php
Ambito
documentation

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

💭 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?
Lingua principale
PHP
Stelle
297
Fork
34
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di utopia-php/http

Tutte le issue di utopia-php/http

Issue simili

Altre issue su PHP

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.