Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Gerar documentação dos códigos python #58

Open
lunhg opened this issue Mar 30, 2020 · 2 comments
Open

Gerar documentação dos códigos python #58

lunhg opened this issue Mar 30, 2020 · 2 comments

Comments

@lunhg
Copy link

lunhg commented Mar 30, 2020

Contexto

Em minhas tentativas de contribuir com o projeto, notei uma dificuldade de entendimento das implementações. Creio que isso pode ajudar outros programadores a resolver as issues.

Proposta

Gerar, através dos comentários e docstrings, páginas de documentação com o auxílio do pacote pycco.

@endersonmaia
Copy link
Collaborator

olá @lunhg o código é muito curto, neste momento, acredito que documentá-lo ainda seja fácil, fique a vontade para mandar um PR

basicamente é o @turicas programando e abrindo mão de documentar para poder entregar resultados breves, acredito que essa colaboração na documentação seja bastante útil

@lunhg
Copy link
Author

lunhg commented Mar 30, 2020

olá @lunhg o código é muito curto, neste momento, acredito que documentá-lo ainda seja fácil, fique a vontade para mandar um PR

basicamente é o @turicas programando e abrindo mão de documentar para poder entregar resultados breves, acredito que essa colaboração na documentação seja bastante útil

Presumi isso @endersonmaia. Pensei nisso quando vi a issue anterior. Fiz uma prévia aqui e aqui sem modificar o funcionamento interno.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants