python / python/typing

Should we add links to existing resources?

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

还没有人认领这个 Issue。

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

描述

I was catching up on a long python-dev discussion about the state of type annotations, and noticed that @gvanrossum had asked for a list of easily discoverable (by search engines) resources regarding typing.

I collected up this note:
https://gist.github.com/stroxler/ade7977ed07e27448222a468796bc467

Would we want to include a couple of the best links (in particular the RealPython blog, maybe the LogRocket one as well) in our docs? At least at this time, those may actually be the two best getting-started tutorials. The mypy docs are much more thorough and incredibly useful as a reference, but aren't really written in a manner where a beginner could easily skim them end-to-end.

贡献指南

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

从这里开始

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

调研方向

先阅读链接的 gist 和现有的类型标注文档,然后将提议的 Real Python 和 LogRocket 教程与 mypy 参考资料进行比较。确认哪些资源适合初学者,并确定应放置外部入门链接的文档页面。完成的标准是:添加所选链接并提供清晰的描述,或者在 issue 中记录不应添加这些链接的原因。

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

评估

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

把新 issue 发到你的邮箱

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