Write and require docstrings for public module functions
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 35/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- python
- 领域
- cli, documentation
调研方向
首先查看 issue #42，确定正在迁移到 Python 模块中的核心功能。列出其公共函数，并决定哪种 docstring 风格和 linting 方式适合该项目。完成的标准是：公共模块函数具有反映其用法的 docstring，并且有测试或 lint 检查验证这些 docstring 的存在。
由索引模型根据 Issue 内容生成。
描述
As part of https://github.com/mapbox/tilesets-cli/issues/42, we'll be moving core functionality to a python module. All public module functions should have a docstring reflecting the usage of said function.
Some initial ideas are:
- Use numpy style docstrings https://numpydoc.readthedocs.io/en/latest/format.html
- Have a linting test that verifies docstring existence
cc @Gerdie
- 主要语言
- Python
- 星标
- 142
- 派生
- 27
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
mapbox/tilesets-cli 的其他 Issue
-
难度 4/5 3-5 天 新手友好度 28/100
mapbox/tilesets-cli#217 · 1 条评论 ·
-
难度 4/5 3-5 天 新手友好度 35/100
mapbox/tilesets-cli#216 · 2 条评论 ·
-
难度 3/5 1-2 天 新手友好度 25/100
mapbox/tilesets-cli#193 · 1 条评论 ·
-
难度 2/5 1-3 小时 新手友好度 35/100
mapbox/tilesets-cli#190 · 1 个 reaction ·
-
难度 3/5 1-2 天 新手友好度 35/100
mapbox/tilesets-cli#171 · 1 个 reaction ·
查看 mapbox/tilesets-cli 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 74/100
eclipse-score/inc_someip_gateway#356 ·
维护者通常 2 天内回复
-
[BUG]: `GitHubRestAdapter.check_user_permission` and `has_write_access` raise `TypeError` (missing `params`), silently disabling the inactivity lifecycle可能已有人在做 @tarunagnihotri534 今天认领。 未关闭bug
难度 2/5 1-3 小时 新手友好度 67/100
AOSSIE-Org/Gitcord-GithubDiscordBot#167 · 1 条评论 ·
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 77/100
mihai-vlc/sublime-jsfmt#56 ·
-
comp/cli comp/plugins P2 type/bug
难度 2/5 1-3 小时 新手友好度 75/100
NousResearch/hermes-agent#141917 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 78/100
riscv/riscv-opcodes#441 ·