[docs] merge error code lists
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 20.6k
- Fork
- 3.3k
- Metriche di merge delle PR
- Metriche PR in attesa
Descrizione
Documentation
error_code_list.rst and error_code_list2.rst should be merged. The main result of having two pages is that half the time I end up checking the wrong page if I don't know beforehand whether the code is enabled or disabled by default. Instead, that enablement information should be documented in each entry (possibly also whether or not it's enabled by default in strict mode, ideally).
To elaborate a little, perhaps unnecessarily, I assume there are three types of interactions we could be designing the error codes page(s) for:
- People reading the documentation cover-to-cover, or similar. Having the error codes split up like this is probably useful to them, but I doubt this is a common interaction.
- People searching for the error codes using a search engine. These people probably get to the right page either way. While this is useful, usually I don't do this and I try to go directly to the error page, because a general search will sometimes give you unhelpful pages that just happened to mention the code
- People already on the page, using ctrl-f to cross-reference or find entries. I think this is a useful activity and it's greatly stymied by having them split apart on different pages.
While we're at it, the current error_codes.rst could just be a preamble, and all three pages could be merged into one.
Ideally, preservative redirects would be made. As in any documentation refactor.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia leggendo error_code_list.rst, error_code_list2.rst e error_codes.rst per comprenderne la struttura attuale e il modo in cui le voci dei codici di errore descrivono l’abilitazione. Pianifica un’unica pagina combinata con i dettagli sull’abilitazione per ogni voce, incluso lo stato della modalità strict quando disponibile, e preserva i redirect dalle pagine esistenti. Il lavoro è completato quando le tre pagine sono state unite senza perdere informazioni e i vecchi URL reindirizzano correttamente.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100