Pygithub: Onde está a documentação ???

Criado em 23 out. 2016  ·  13Comentários  ·  Fonte: PyGithub/PyGithub

Onde está a documentação da biblioteca ??

Todos 13 comentários

Onde estão os arquivos de documentação? Não consegui encontrá-los em / doc: https://github.com/PyGithub/PyGithub/tree/master/doc. Eles precisam de uma atualização e eu ficaria feliz em fazer um PR se eles estivessem disponíveis

@ericbrandwein Os detalhes da documentação estão no próprio código: https://github.com/PyGithub/PyGithub/blob/master/github/Commit.py#L159 -L166

@MichaelPereira oh ótimo, então a documentação sobre ReadTheDocs precisa de uma atualização, porque o botão "editar no github" me envia para o diretório /doc neste repositório 😕

O que é bom porque é onde a introdução, o índice, etc. estão localizados, mas a localização da documentação do código poderia ser um pouco mais explícita

Seria bom se o README contivesse um link para os documentos.

@gvanrossum Aí está.

2016-11-01 19-35-43

Escondido à vista. :-(

Esse é o problema quando você tem muitos emblemas. Acho que documentos é um pouco mais importante do que um emblema, então isso definitivamente deve ser expandido mais no leia-me.

Além do README, seria melhor se o link para o documento fosse adicionado aqui:
url_here

IMHO @gvanrossum e @tmshn estão
Na verdade, a descrição em readme.md poderia ser nada mais do que o link para os documentos corretos (porque a descrição atual contém apenas links para fontes superconhecidas.
@jzelinskie , se você tiver acesso, aprove @gamefiend 's https://github.com/PyGithub/PyGithub/pull/499

Fechado por # 499

Esta página foi útil?
0 / 5 - 0 avaliações