Python: conda environment.yml is a dependency declaration; a docs-site static-analysis FAIL should not outweigh the product's PASS

未关闭
#281 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
55/100
Issue 类型
缺陷
描述清晰度
基本清楚
活跃度
活跃
技术栈
anaconda, python

调研方向

The bug is in the dependency-management check and the documentation static-analysis check of project_validator, which the payload does not name by file. Start by grepping the Python sources for requirements.txt to find the dependency message, then reproduce with a repo that contains only environment.yml. Done when the message names the conda file and the docs sub-result WARNs instead of FAILing when the product check passes.

由索引模型根据 Issue 内容生成。

描述

handson-ml3 and PythonDataScienceHandbook declare their environment in environment.yml (conda) but the message pretends only requirements.txt exists ("declared in requirements.txt but not locked"). Every Sphinx/MkDocs Python project FAILs static-analysis "Documentation site: no static analyzer runs; Python: ruff check runs" — with the product passing, the docs sub-result should at most WARN, and the hint should name an rst/markdown linter.

Evidence from the corpus audit

ageron/handson-ml3, jakevdp/PythonDataScienceHandbook / dependency-management
  • kind: UNSUPPORTED
  • actual: handson-ml3 WARN: dependencies are declared in requirements.txt (Python packages) but not locked; PDSH WARN: ... declared in requirements.txt (Python packages) but not locked
  • expected: the conda environment should be named as a declaration (and judged: environment.yml pins are not a lock file either, but the message should not pretend only requirements.txt exists)
  • evidence: handson-ml3 environment.yml:1-4: name: homl3 / channels: / - conda-forge / dependencies:; environment.yml:26: - python=3.10 # your beloved programming language! :); PDSH environment.yml (117 bytes); grep -rn -i "conda\|environment.yml" project_validator --include=*.py → nothing
  • repro: a repo with environment.yml only
  • confidence: high (conda is the dominant dependency tool of the Jupyter/data-science ecosystem)

Found by the regression-corpus audit (235 real repositories, one or more per ecosystem profile; corpus and expected results in corpus/). Evidence is quoted from the audited checkouts at the commits pinned in corpus/projects.toml; <checkouts>/<owner>__<repo> is such a checkout.

🤖 Generated with Claude Code

https://claude.ai/code/session_01ByTXNqDWdM7HzezrFtEvQt

主要语言
Python
星标
4
派生
1
平均合并
10 小时 41 分钟
30 天内合并 PR
79

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

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

cpp-best-practices/project_validator 的其他 Issue

查看 cpp-best-practices/project_validator 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

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