Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

[CI] Linting of docs

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

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
35/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
停滞
技术栈
python

调研方向

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

环境准备

从这里开始

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

openml/openml-python 的其他 Issue

查看 openml/openml-python 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

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