aws / aws/aws-encryption-sdk-python
encrypt/decrypt/stream API docs are missing new commitment_policy parameter
Aberta
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- Python
- Estrelas
- 255
- Forks
- 92
- Merge médio
- 2d 17h
- PRs com merge (30d)
- 2
Descrição
I was talking with @seebees about this and noticed that the changes to the encrypt/decrypt/stream API parameters was not documented in the docstrings (and thus the rendered API docs).
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.
Direção de pesquisa
Localize as docstrings da API de encrypt, decrypt e stream e compare os parâmetros documentados com o argumento commitment_policy atual. Atualize a documentação do parâmetro ausente e verifique se a documentação da API renderizada o inclui para todas as três APIs.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- python
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 45/100