Improve docstrings for Hooks
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Facilidade para iniciantes
- 45/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 localizando as interfaces públicas de Hook, incluindo HookContext, no pacote cloudformation_cli_python_lib e, em seguida, compare-as com o exemplo gerado ../handlers.py e com a documentação Implement Hook handlers (Python). Verifique como request.hookContext e targetModel são expostos. O trabalho estará concluído quando as classes e propriedades públicas relevantes tiverem docstrings de Python úteis que expliquem seu significado e os valores esperados.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
Hi there 👋,
It would be nice to have Python docstrings included on the public interfaces when developing hooks.
Would pull requests for docstrings be welcome?
For example, after cfn init for hooks, we have a ../handlers.py that looks similar to this:
In Visual Studio Code, when I hover over cloudformation_cli_python_lib specific classes/properties I don't get any information for what they are, or what to expect.
I couldn't find out what all the request.hookContext properties mean, and what dict keys are available on request.hookContext.targetModel from the Implement Hook handlers (Python) documentation.
In the case of HookContext some docstrings like this would be welcome:
Cheers,
Neil
- Linguagem predominante
- Python
- Estrelas
- 107
- Forks
- 46
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
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 aws-cloudformation/cloudformation-cli-python-plugin
-
Support UVAberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
-
Repo alive?Aberta
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 20/100
aws-cloudformation/cloudformation-cli-python-plugin#270 · 1 comentário · 1 reação ·
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 35/100
aws-cloudformation/cloudformation-cli-python-plugin#268 · 1 comentário · 2 reações ·
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 35/100
aws-cloudformation/cloudformation-cli-python-plugin#264 · 1 comentário ·
-
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 25/100
aws-cloudformation/cloudformation-cli-python-plugin#263 · 2 comentários · 3 reações ·
Todas as issues de aws-cloudformation/cloudformation-cli-python-plugin
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 85/100
kornia/kornia#5263 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
approved correction metadata
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 88/100
acl-org/acl-anthology#10133 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
BasedHardware/omi#20084 ·
Mantenedores costumam responder em até 1 dia
-
bug needs-acceptance wg/evaluation-quality
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
vllm-project/semantic-router#4424 ·
Mantenedores costumam responder em até 1 dia