marshmallow-code / marshmallow-code/webargs

Add an 'Examples' page to the docs with fully functioning example applications

Open
#644 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
Python
Stars
1.4k
Forks
167
Avg merge
17h 8m
Merged PRs (30d)
4

Description

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](https://github.com/marshmallow-code/webargs/issues/640#issuecomment-930276628)
- [Axios Query-String Parser](https://github.com/marshmallow-code/webargs/issues/517#issuecomment-634061481)
- Setting a parser to use `unknown=RAISE` on 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).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked issue comments for the Django CSRF-removing parser and Axios query-string parser, then inspect the existing webargs documentation and upgrade guide for other candidates. Define the Examples page structure and select a focused set of fully functioning applications. Done means the page and runnable examples cover the agreed cases without bloating the main documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
django, javascript, python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.