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