marshmallow-code / marshmallow-code/webargs
Add an 'Examples' page to the docs with fully functioning example applications
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 1.4k
- Fork
- 167
- Merge medio
- 17h 8m
- PR unite (30g)
- 4
Descrizione
There are a few cases of interesting usages that come up in issues, but which don't seem appropriate to put into our main docs (b/c we don't want to bloat our docs). If we had an Examples page in the docs, we could show off all of our cool ideas for how you can solve problems with webargs, but without disrupting the flow of the main documentation.
Specific cases which would be good candidates for example apps:
- Django App with CSRF-Removing Parser
- Axios Query-String Parser
- Setting a parser to use
unknown=RAISEon query params
I did a quick scan of closed issues until I hit the 5.x/6.0 transition point, then called it a day. Maybe there are other interesting examples in older issues? Or maybe we have things in other parts of the docs like the upgrade guide which would be nice to separate out (or even just duplicate).
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 esaminando i commenti dell’issue collegata relativi al Django CSRF-removing parser e all’Axios query-string parser, quindi controlla la documentazione esistente di webargs e la guida all’upgrade per individuare altri candidati. Definisci la struttura della Examples page e seleziona un insieme mirato di applicazioni completamente funzionanti. Il lavoro è considerato completato quando la pagina e gli esempi eseguibili coprono i casi concordati senza appesantire la documentazione principale.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- django, javascript, 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
- 35/100