Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Improve API doc for users

Aberta
  • Algo errado?
#529 1 comentário 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 3 dias

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
4/5
Tempo estimado
3-5 dias
Facilidade para iniciantes
35/100
Tipo de issue
Documentação
Clareza
Precisa de esclarecimento
Status de atividade
Estagnada
Stack de tecnologia
python
Domínio
documentation

Direção de pesquisa

Revise primeiro a documentação publicada da API em https://appium.github.io/python-client-sphinx/ e, em seguida, compare-a com os exemplos do Sphinx e as referências do Napoleon Config listados na issue. Identifique lacunas concretas para os usuários e atualize a documentação; considera-se concluído quando a referência da API estiver mais fácil de usar.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

Documentation help wanted task

The problem

Just published API doc.
https://appium.github.io/python-client-sphinx/

However, it is just first revision and could be more user friendly.

References

Linguagem predominante
Python
Estrelas
1.8k
Forks
570
Merge médio
1d 10h
PRs com merge (30d)
24

Preparar o ambiente

Ainda não verificamos os arquivos de configuração deste projeto. Comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de appium/python-client

Todas as issues de appium/python-client

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.