marshmallow-code / marshmallow-code/webargs
Add an 'Examples' page to the docs with fully functioning example applications
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 1.4k
- Forks
- 167
- Ø Merge
- 17 Std. 8 Min.
- Gemergte PRs (30 T.)
- 4
Beschreibung
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).
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die Kommentare zum verknüpften Issue zum Django CSRF-removing parser und zum Axios query-string parser zu prüfen, und untersuche anschließend die vorhandene webargs-Dokumentation und den Upgrade-Leitfaden auf weitere Kandidaten. Lege die Struktur der Examples page fest und wähle eine fokussierte Gruppe vollständig funktionsfähiger Anwendungen aus. Als erledigt gilt die Aufgabe, wenn die Seite und die ausführbaren Beispiele die vereinbarten Fälle abdecken, ohne die Hauptdokumentation aufzublähen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- django, javascript, python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100