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

未關閉
#644 5 則留言 1 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 1 天內回覆

還沒有人認領這個 Issue。

評估

難度
4/5
預估耗時
3-5 天
新手友好度
35/100
Issue 類型
文件
描述清晰度
基本清楚
活躍度
停滯
領域
documentation

研究方向

先查看關於 Django CSRF-removing parser 和 Axios query-string parser 的連結 issue 留言,接著檢查現有的 webargs 文件和升級指南,以尋找其他候選項。定義 Examples page 的結構,並選擇一組聚焦且完全可運作的應用程式。當頁面和可執行範例涵蓋約定的案例,且不使主要文件變得臃腫時,即表示完成。

由索引模型根據 Issue 內容生成。

描述

docs

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:

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 範本
  • 閱讀貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

marshmallow-code/webargs 的其他 Issue

查看 marshmallow-code/webargs 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。