docs: Include the relevant securesystemslib classes in docs
Mantenedores costumam responder em até 10 dias
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Facilidade para iniciantes
- 35/100
- Tipo de issue
- Documentação
- Clareza
- Razoavelmente clara
- Status de atividade
- Estagnada
- Stack de tecnologia
- python
- Domínio
- documentation
Direção de pesquisa
Comece revisando a documentação existente da API do python-tuf e como suas diretivas autodoc estão organizadas. Determine se incluir securesystemslib.signer.Signature e as classes relacionadas atende ao objetivo da Metadata API sem documentar APIs não relacionadas do securesystemslib. Considera-se concluído quando as classes relevantes estiverem documentadas ou vinculadas por meio de uma abordagem focada e acordada.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
Signer, Signature (and in future maybe most of Key) are really part of the Metadata API but are technically implemented in securesystemslib.
We should either include those in the python-tuf API docs, or create similar docs for securesystemslib and link to those (but we don't want to document the rest of securesystemslib API in the same manner).
The former (including in python-tuf api docs) might be quite simple as plain:
.. autoclass:: securesystemslib.signer.Signature
seems to get us most of the way there...
- Linguagem predominante
- Python
- Estrelas
- 1.7k
- Forks
- 304
- Merge médio
- 9h 25min
- PRs com merge (30d)
- 14
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Tem um modelo de pull request
- Ler o guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de theupdateframework/python-tuf
-
switch to main branch?Aberta
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 48/100
theupdateframework/python-tuf#3001 ·
Mantenedores costumam responder em até 10 dias
-
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 42/100
theupdateframework/python-tuf#2979 · 1 comentário ·
Mantenedores costumam responder em até 10 dias
-
Use Immutable ReleasesAbertaenhancement github_actions
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 45/100
theupdateframework/python-tuf#2920 · 1 comentário · 2 reações ·
Mantenedores costumam responder em até 10 dias
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 35/100
theupdateframework/python-tuf#2842 · 3 comentários ·
Mantenedores costumam responder em até 10 dias
-
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 25/100
theupdateframework/python-tuf#2836 · 7 comentários ·
Mantenedores costumam responder em até 10 dias
Todas as issues de theupdateframework/python-tuf
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
PedestrianDynamics/pyFDS-Evac#199 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 65/100
521xueweihan/HelloGitHub#3790 ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
sandialabs/atlas-ui-3#978 ·
Mantenedores costumam responder em até 1 dia
-
area: tests perceived difficulty: 2
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
Nitjsefnie-Harness-Commons/daedalus#1255 ·
Mantenedores costumam responder em até 1 dia
-
hf-audiolm-qwen: `generate_until` hardcodes `.to("cuda")` and aborts on non-CUDA acceleratorsAberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 86/100
EleutherAI/lm-evaluation-harness#4256 ·
Mantenedores costumam responder em até 1 dia