python / python/devguide

Argument Clinic: add reference for the DSL

未關閉
#1,270 3 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

type-feature
主要語言
Python
星號
2.1k
分支
1k
平均合併
2 天 12 小時
30 天內合併 PR
12

描述

We need a better reference for the Argument Clinic DSL:

  • legal syntax for the "function name" line
  • legal syntax for parameter lines
  • legal syntax for docstrings

貢獻指南

開啟貢獻指南

從這裡開始

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

研究方向

先找到現有的 Argument Clinic 文件,以及 devguide 中目前的所有 DSL 參考。將文件涵蓋的內容與所要求的函式名稱語法、參數列語法和 docstring 語法進行比較;當有一份參考文件說明這三個領域的合法語法時,工作就完成了。

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

評估

技術堆疊
python
領域
documentation
Issue 類型
文件
難度
3/5
預估耗時
1-2 天
活躍度
停滯
描述清晰度
基本清楚
新手友好度
45/100

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

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