python / python/typeshed

Improving type annotations in Sphinx

未关闭
#11,621 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
Python
星标
5.1k
派生
2.1k
平均合并
1 天 19 小时
30 天内合并 PR
82

描述

@JelleZijlstra, @srittau thanks for all your help with the docutils type stubs.

The point of all these PRs is facilitate migrating the venerable Sphinx project from docutils-stubs to types-docutils.

There's a PR for that here - https://github.com/sphinx-doc/sphinx/pull/12012

there's still a number of errors remaining. Some are issues with Sphinx, others with the type annotations themselves.
I wonder if you have any bandwidth to help me get this PR over the line, and get Sphinx using typeshed once and for all?

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先查看 Sphinx PR #12012 以及其中描述的剩余错误。在确定哪些错误属于 Sphinx、哪些错误属于类型注解的同时,比较 docutils-stubs 和 types-docutils 的注解。剩余错误都得到处理且 Sphinx 可以使用 typeshed 后,即视为完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
devtools
Issue 类型
重构
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
需要澄清
新手友好度
25/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。