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

Ouverte
  • Quelque chose ne va pas ?
#281 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
55/100
Type d'issue
Bug
Clarté
Plutôt claire
Activité
Active
Stack technique
anaconda, python
Domaine
documentation, tooling

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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

Langage dominant
Python
Étoiles
4
Forks
1
Merge moyen
10 h 41 min
PR mergées (30 j)
79

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de cpp-best-practices/project_validator

Toutes les issues de cpp-best-practices/project_validator

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.