python / python/typing

Expand documentation for integrating type stubs into existing code bases

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

还没有人认领这个 Issue。

topic: documentation
主要语言
Python
星标
1.8k
派生
302
平均合并
23 小时
30 天内合并 PR
8

描述

On https://typing.readthedocs.io/en/latest/index.html there are various sections to help users find tools such as type checkers, linters and formatters, and development environments with type support.

I had previously asked in python/typeshed#8482 how would a user go about integrating existing type stubs into their application. This may be due to a third party or typeshed having created stubs either because the type hints were missing in a library or the provided type information was sufficiently inaccurate to encourage the user to take this type of action.

The team was kind enough to suggest various tools to assist with addressing this problem, and I was wondering if there was an appetite by the team here to incorporate a new "Type Stub Integration" section (or a different proposed name) to the Typing-Related Tools section?

贡献指南

这个仓库没有索引到贡献指南

从这里开始

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

调研方向

首先阅读 https://typing.readthedocs.io/en/latest/index.html 中的 Typing-Related Tools 部分,以及 python/typeshed#8482 中引用的集成讨论。确定 Type Stub Integration 部分的适当范围和命名,然后更新文档,以便用户能够找到用于集成现有存根的指南和相关工具。

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

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
42/100

把新 issue 发到你的邮箱

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