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

Đang mở
  • Có gì không ổn?
#281 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
55/100
Loại issue
Lỗi
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
anaconda, python
Lĩnh vực
documentation, tooling

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

Ngôn ngữ chính
Python
Star
4
Fork
1
Merge trung bình
10 giờ 41 phút
Pull request đã merge (30 ngày)
79

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của cpp-best-practices/project_validator

Tất cả issue của cpp-best-practices/project_validator

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.