[CI] Linting of docs
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 35/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- python
- 领域
- ci-cd, documentation, tooling
调研方向
Review the repository's CI configuration and supported Python versions first, then compare ruff and pydocstyle against the Python 3.6 compatibility constraint and the proposed Python 3.7+ environment. Done means documentation and docstrings are linted in CI without breaking supported environments, addressing the class of issue described in #716.
由索引模型根据 Issue 内容生成。
描述
Currently there is no linter for doc and docstrings.
As a follow up, this should really be linted. I would advocate using ruff but theoretically that's blocked on still supporting python 3.6 (#1083).
Should work if working in an environment that's 3.7+ though.
The alternative is to use pydocstyle.
This would prevent issues like #716 from appearing. (which I guess can be closed now?)
- 主要语言
- Python
- 星标
- 362
- 派生
- 304
- 平均合并
- 2 天 20 小时
- 30 天内合并 PR
- 2
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
openml/openml-python 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 84/100
openml/openml-python#1753 · 1 条评论 ·
维护者通常 1 天内回复
-
[ENH] list_estimation_procedures() should include the procedure IDs可能已有人在做 @Jayant-kernel 于 7 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 70/100
openml/openml-python#1750 · 3 条评论 · 已指派 1 人 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 88/100
openml/openml-python#1749 ·
维护者通常 1 天内回复
-
Documentation Good First Issue
难度 2/5 1-3 小时 新手友好度 74/100
openml/openml-python#1708 · 8 条评论 ·
维护者通常 1 天内回复
-
Good First Issue module:Run testing
难度 2/5 1-3 小时 新手友好度 82/100
openml/openml-python#1646 · 9 条评论 · 3 个 reaction ·
维护者通常 1 天内回复
查看 openml/openml-python 的全部 Issue
相似的 Issue
-
#bug
难度 1/5 1 小时以内 新手友好度 92/100
apache/superset#44923 · 1 条评论 ·
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 84/100
lawndoc/stack-back#123 ·
-
Add: Entune未关闭
难度 2/5 1-3 小时 新手友好度 76/100
AbdelStark/awesome-typesafe-jev#187 ·
维护者通常 1 天内回复
-
bug good first issue
难度 2/5 1-3 小时 新手友好度 88/100
repowise-dev/repowise#2966 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 84/100
维护者通常 2 天内回复