Typing spec: Improve cross-linking
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 42/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- python
调研方向
首先查看已链接的 typing spec，尤其是类型系统页面和所引用的 pull request。确定一小组需要更新的 PEP 或 feature 引用，然后验证相关 spec 部分已建立链接，并确认新增的链接目标能够在生成的文档中正确解析。
由索引模型根据 Issue 内容生成。
描述
We should improve links within the spec. Concretely:
- Replace links to PEPs with links to the relevant part of the spec (https://github.com/python/typing/pull/1517#pullrequestreview-1763857938)
- Where we mention a feature, link it to the relevant spec section (e.g., whenever we mention
Annotated, it should link to the spec section that describesAnnotated). - Strategically add link targets so other Sphinx docs (e.g., docs.python.org, the PEPs) can link to the spec
This can be done in small increments, one PR at a time, and doesn't need signoff from the Typing Council. Contributions are welcome.
- 主要语言
- Python
- 星标
- 1.8k
- 派生
- 302
- 平均合并
- 23 小时
- 30 天内合并 PR
- 8
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
python/typing 的其他 Issue
-
topic: typing spec
难度 2/5 1-3 小时 新手友好度 72/100
-
topic: typing spec
难度 2/5 1-3 小时 新手友好度 75/100
-
topic: documentation
难度 2/5 1-3 小时 新手友好度 76/100
-
topic: documentation
难度 2/5 1-3 小时 新手友好度 65/100
-
topic: conformance tests topic: typing spec
难度 3/5 1-2 天 新手友好度 72/100
相似的 Issue
-
enhancement
难度 2/5 1-3 小时 新手友好度 70/100
canonical/paas-charm#368 · 1 条评论 ·
-
难度 2/5 1-3 小时 新手友好度 75/100
-
tech debt
难度 2/5 1-3 小时 新手友好度 75/100
-
难度 1/5 1 小时以内 新手友好度 90/100
StevenBlack/hosts#3256 ·
-
难度 1/5 1 小时以内 新手友好度 90/100
qualcomm/qai-appbuilder#275 ·