Add an 'Examples' page to the docs with fully functioning example applications
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 35/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- django, javascript, python
调研方向
首先查看关于 Django CSRF-removing parser 和 Axios query-string parser 的关联 issue 评论,然后检查现有的 webargs 文档和升级指南,寻找其他候选项。定义 Examples page 的结构,并选择一组重点明确且完全可运行的应用。页面和可运行示例覆盖约定的案例,且不会使主文档变得臃肿,即视为完成。
由索引模型根据 Issue 内容生成。
描述
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).
- 主要语言
- Python
- 星标
- 1.4k
- 派生
- 171
- 平均合并
- 8 小时 47 分钟
- 30 天内合并 PR
- 12
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
marshmallow-code/webargs 的其他 Issue
-
Multi-value tornado headers are fetched with `get()` rather than `get_list()`可能重新可做 关联的 PR 已关闭且未合并。 未关闭
难度 2/5 1-3 小时 新手友好度 62/100
marshmallow-code/webargs#1109 · 1 条评论 ·
维护者通常 1 天内回复
-
Improve Falcon parser可能已有人在做 @vytas7 于 112 天前认领。 未关闭
难度 5/5 一周以上 新手友好度 35/100
marshmallow-code/webargs#1079 · 7 条评论 · 2 个 reaction ·
维护者通常 1 天内回复
-
难度 4/5 3-5 天 新手友好度 20/100
marshmallow-code/webargs#1046 ·
维护者通常 1 天内回复
-
question
难度 3/5 1-2 天 新手友好度 35/100
marshmallow-code/webargs#549 · 15 条评论 ·
维护者通常 1 天内回复
-
feedback welcome
难度 5/5 一周以上 新手友好度 28/100
marshmallow-code/webargs#353 · 6 条评论 · 6 个 reaction ·
维护者通常 1 天内回复
查看 marshmallow-code/webargs 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 68/100
btclib-org/btclib#3062 ·
维护者通常 1 天内回复
-
area:evals area:infra enhancement
难度 2/5 1-3 小时 新手友好度 74/100
jse-avl/support-bot#4 · 1 条评论 ·
-
bug good first issue
难度 2/5 1-3 小时 新手友好度 85/100
qte77/agentic-job-offer-to-application-kit#487 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 82/100
btclib-org/btclib-wallet#801 · 1 条评论 ·
维护者通常 1 天内回复
-
documentation good first issue
难度 1/5 1-3 小时 新手友好度 94/100