querido-diario-comunidade icon indicating copy to clipboard operation
querido-diario-comunidade copied to clipboard

Melhorias na Documentação da Toolbox

Open trevineju opened this issue 2 years ago • 1 comments

Como o objetivo do Read the Docs é ser a documentação técnica, dos recursos do Querido Diário, seu conteúdo deve ser enxuto, expondo o suficiente para busca rápidas e localização das respostas facilmente. A referência é a documentação de Python que lista e descreve muito objetivamente para que tal comando serve (exemplo: https://docs.python.org/3/library/string.html?highlight=string#module-string)

Assim, a melhoria na página da Toolbox seria adequá-a nesse modelo de documentação técnica "tradicional", por exemplo:

class Gazette

gazette.extract_content() explica o que faz

gazette.load_content() explica o que faz

Para conhecê-los, basta verificar em https://github.com/okfn-brasil/querido-diario-toolbox/tree/main/querido_diario_toolbox as classes que a toolbox oferece e seus métodos. Por enquanto, os módulos em etl não precisam ser incluídos.

Da página já em exibição, o tópico de instalação pode ser mantido, enquanto o tópico de "Exemplos de uso" que deve ser substituido pela listagem das classes/métodos

trevineju avatar Oct 21 '22 00:10 trevineju