jazzband/pip-tools

Document that pyproject.toml dependencies are supported

Open

#1528 aperta il 5 nov 2021

Vedi su GitHub
 (3 commenti) (7 reazioni) (0 assegnatari)Python (605 fork)batch import
PR wanteddocsgood first issue

Metriche repository

Star
 (7230 star)
Metriche merge PR
 (Merge medio 1g 21h) (3 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Aggiorna la documentazione per menzionare esplicitamente che pyproject.toml è supportato per specificare le dipendenze, insieme a setup.py e requirements.in. Controlla i file di documentazione esistenti (es. README, docs/index.rst) e modifica le frasi pertinenti. Verifica anche se ci sono altri riferimenti da aggiornare.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90