jazzband/pip-tools

Document that pyproject.toml dependencies are supported

Offen

#1.528 geöffnet am 05.11.2021

Auf GitHub ansehenContributor Guide
 (3 Kommentare) (7 Reaktionen) (0 zugewiesene Personen)Python (670 Forks)batch import
PR wanteddocsgood first issue

Repository-Metriken

Stars
 (8.009 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 1T 21h) (3 gemergte PRs in 30 T)

Beschreibung

What's the problem this feature will solve?

Issues like: #1510, general confusion

Describe the solution you'd like

At the moment, the docs include phrases like:

The pip-compile command lets you compile a requirements.txt file from your dependencies, specified in either setup.py or requirements.in.

pip-compile generates a requirements.txt file using the latest versions that fulfil the dependencies of setup.py or requirements.in.

To me, and I assume the person who opened #1510, this reads like only setup.py or requirements.in are supported.

Contributor Guide

Research-Richtung
Aktualisieren Sie die Dokumentation, um explizit zu erwähnen, dass pyproject.toml für die Angabe von Abhängigkeiten unterstützt wird, neben setup.py und requirements.in. Überprüfen Sie die vorhandenen Dokumentationsdateien (z. B. README, docs/index.rst) und ändern Sie die entsprechenden Sätze. Überprüfen Sie auch, ob es weitere Referenzen gibt, die aktualisiert werden müssen.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90