Improve readability of annotation syntaxes
還沒有人認領這個 Issue。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 25/100
- Issue 類型
- 文件
- 描述清晰度
- 需要釐清
- 活躍度
- 停滯
研究方向
從連結的 annotations/#understanding-this-page 頁面開始，並檢視 issue 中顯示的複雜語法範例。該 issue 沒有定義偏好的替代方案或明確的完成測試；要視為完成，必須就更易讀的表示法達成共識，並更新文件範例。
由索引模型根據 Issue 內容生成。
描述
The method currently used for describing how to use annotations can be easy to understand at times:
---@type <type>
And also impossible for mere mortals to understand:
---@cast <value_name> [+|-]<type|?>[, [+|-]<type|?>...]
---@overload fun([param: type[, param: type...]]): [return_value[,return_value]]
There must be a better way to represent these more complex syntaxes while also not using symbols regularly in use (<, >, (, ), [, ], {, }, @, #, -, +, =, :, ", ,, ., ?). Although now that I have listed some in-use symbols, I realize we really are quite limited. It is hard to explain a syntax that uses many symbols… using symbols.
I'm open to any suggestions on how this can be improved 🙂
- 主要語言
- MDX
- 星號
- 10
- 分支
- 19
- PR 合併指標
- 30 天內沒有已合併 PR
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 沒有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
相似的 Issue
-
難度 1/5 1 小時以內 新手友好度 72/100
MIT-LCP/wfdb-python#590 ·
維護者通常 1 天內回覆
-
難度 1/5 1-3 小時 新手友好度 88/100
vigetlabs/wordpress-site-starter#315 ·
維護者通常 15 天內回覆
-
documentation good first issue
難度 2/5 1-3 小時 新手友好度 77/100
維護者通常 1 天內回覆
-
documentation good first issue
難度 2/5 1-3 小時 新手友好度 76/100
維護者通常 1 天內回覆
-
難度 1/5 1 小時以內 新手友好度 68/100
JustAResearcher/gpu-unlock-ada#110 ·
維護者通常 1 天內回覆