Add a tool to count and report the missing docstrings
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 30/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- python
- 领域
- documentation, tooling
调研方向
首先检查现有的 Element 和 GDScriptClass 实现，以确定如何报告文档信息。然后定义新模块的输入和日志记录职责；当它生成一个显示文档进度和缺失 docstring 的表格时，即视为完成。
由索引模型根据 Issue 内容生成。
描述
We could have a tool similar to Godot's doctool, that gives a table with the docs progress and missing docstrings.
We can add methods on Element and GDScriptClass to report that information easily. Then, a new module should take care of reading and logging that information.
- 主要语言
- Python
- 星标
- 297
- 派生
- 26
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
GDQuest/gdscript-docs-maker 的其他 Issue
-
KeyError: 'name' while generating markdown files可能重新可做 关联的 PR 已关闭且未合并。 未关闭
难度 3/5 1-2 天 新手友好度 38/100
GDQuest/gdscript-docs-maker#95 · 4 条评论 · 1 个 reaction ·
-
难度 2/5 1-3 小时 新手友好度 45/100
-
enhancement
难度 4/5 3-5 天 新手友好度 35/100
-
enhancement
难度 2/5 1-3 小时 新手友好度 55/100
GDQuest/gdscript-docs-maker#86 · 1 个 reaction ·
-
bug
难度 3/5 1-2 天 新手友好度 35/100
GDQuest/gdscript-docs-maker#71 · 3 条评论 ·
查看 GDQuest/gdscript-docs-maker 的全部 Issue
相似的 Issue
-
documentation
难度 2/5 1-3 小时 新手友好度 72/100
ianktoo/project-monitor#14 ·
-
security
难度 2/5 1-3 小时 新手友好度 84/100
btclib-org/btclib-wallet#478 ·
维护者通常 1 天内回复
-
security
难度 2/5 1-3 小时 新手友好度 75/100
btclib-org/btclib#2727 ·
维护者通常 1 天内回复
-
good first issue lead variant:container
难度 2/5 1-3 小时 新手友好度 76/100
radialmonster/orf-cleanroom#10 ·
维护者通常 1 天内回复
-
gdsa opencode: keep-alive cleanup trap fails with 'keepalive_pid: unbound variable'可能已有人在做 @darribas 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 85/100