Generate proper documentation
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 文档
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- python
调研方向
先查看 README.md 和 CHANGELOG.md，然后将项目当前的文档设置与 Trio 使用的上述 ReadTheDocs 和 Sphinx 工作流进行比较。在进行更改之前，确定文档结构、超链接方式以及错误消息的处理方式；当项目信息和错误代码指南得到整理，并且生成的链接或内容仍易于维护时，即视为完成。
由索引模型根据 Issue 内容生成。
描述
README.md has grown to 200 lines, and spans error codes, installation & run instructions, configuration and command-line flags. We also have CHANGELOG.md with 150 lines.
There are a few links in the readme, but it would probably be quite useful to have anything referring to [objects within] urllib3, httpx, anyio, asyncio, trio, etc be hyperlinks w/o having to manually update.
Pulling out the error messages for the documentation automatically would be nice, but somewhat complicated given the current setup for messages differing for different (combinations of) libraries. Should be quite doable though.
https://github.com/python-trio/flake8-async/issues/211#issuecomment-1971778351
I'm planning to write up some more detail about each of our error codes in a long doc, hopefully this weekend, which will include much more about why you'd want to enable each of the optional rules in addition to the existing material.
This also sounds like great doc material.
The one workflow I'm decently accustomed to is ReadTheDocs+Sphinx as used in python-trio/trio, and probably nice to be consistent with it since it's in the same organization. But it's also been a huge pain to work with at times.
- 主要语言
- Python
- 星标
- 26
- 派生
- 11
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
python-trio/flake8-async 的其他 Issue
-
rule improvement
难度 2/5 1-3 小时 新手友好度 68/100
python-trio/flake8-async#457 · 1 个 reaction ·
-
Extend ASYNC401 to other forms可能已有人在做 @anshurajbisoyi98-ctrl 于 9 天前认领。 未关闭
难度 3/5 1-2 天 新手友好度 68/100
python-trio/flake8-async#475 · 1 条评论 · 1 个 reaction ·
-
new rule
难度 3/5 1-2 天 新手友好度 55/100
python-trio/flake8-async#454 · 1 条评论 ·
-
rule improvement
难度 3/5 1-2 天 新手友好度 62/100
python-trio/flake8-async#447 · 5 条评论 ·
-
New rule: `ASYNC233` for blocking `pathlib` methods可能已有人在做 @paranoa233 于 97 天前认领。 未关闭good first issue
难度 5/5 一周以上 新手友好度 15/100
python-trio/flake8-async#396 · 1 条评论 ·
查看 python-trio/flake8-async 的全部 Issue
相似的 Issue
-
难度 1/5 1 小时以内 新手友好度 82/100
esphome/esphome.io#7657 ·
维护者通常 1 天内回复
-
comp/gateway comp/plugins duplicate P3 type/bug
难度 2/5 1-3 小时 新手友好度 82/100
NousResearch/hermes-agent#137019 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 67/100
NVIDIA/structured-data-models#1091 ·
维护者通常 1 天内回复
-
[work-item] adam-adae-worsening-emergence: conform spec.yaml to the specification style contract (REQ-1280)可能已有人在做 @muse-yamaa-bot 今天认领。 未关闭work-item
难度 1/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复