jazzband/pip-tools

Document that pyproject.toml dependencies are supported

Fechada

#1.528 aberto em 5 de nov. de 2021

Ver no GitHubGuia do colaborador
 (3 comentários) (7 reações) (0 responsável)Python (670 forks)batch import
PR wanteddocsgood first issue

Métricas do repositório

Stars
 (8.008 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

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.

Guia do colaborador

Direção de pesquisa
Atualize a documentação para mencionar explicitamente que o pyproject.toml é suportado para especificar dependências, juntamente com setup.py e requirements.in. Verifique os arquivos de documentação existentes (por exemplo, README, docs/index.rst) e modifique as frases relevantes. Verifique também se há outras referências que precisam ser atualizadas.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
None
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90