Starts the documentation #111
Conversation
|
@lucassimon obrigado pelo PR! realmente a lib está precisando bastante de documentação vamos analisar seu PR e damos feedback assim que nos for possível. |
|
|
||
| zip_address = client.find_zipcode(ZipCode(zip_code)) | ||
|
|
||
| Script completo |
There was a problem hiding this comment.
acho que o melhor lugar para esse script seria em na pasta samples/, pois tanto código assim não fica muito bem numa documentação
| @@ -0,0 +1,140 @@ | |||
| Busca de endereço | |||
There was a problem hiding this comment.
este repositório e na @olist usamos por padrão o inglês, então a documentação deveria ser em inglês tb. obviamente como o público-alvo da lib são brasileiros seria importante manter a internacionalização disso http://www.sphinx-doc.org/en/stable/intl.html
dessa forma, acho que este arquivo como está (em português) não deve entrar no repositório. porém isto não invalida seu PR, tem algumas coisas bem interessantes que podemos aproveitar 🙂
requirements-test.txt
Outdated
| pytest | ||
| pytest-cov | ||
| pytest-factoryboy | ||
| pytest-factoryboy==2.0.1 |
There was a problem hiding this comment.
pelo o que entendi tinha um problema na versão 2.9 do factory-boy há um tempo atrás, mas imagino que já tenha sido corrigida. precisa mesmo fixar essas versões? vc testou com ambas as libs em suas últimas versões para ver se funciona?
|
@lamenezes o que podemos fazer com esse PR? Sugiro ter um diretório pt_BR e um en dentro de |
|
Vou fazer o merge e ajustar isso. |
Ref #1
Primeiramente desculpe se este comentário não está em inglês. Eu tenho uma tarefa para realizar com este pacote e senti uma carência de uma documentação por isso estou fazendo este PR. Quero colocar na plataforma readthedocs.io porém gostaria que você me ajudasse seguindo os passos solicitados neste link: http://dont-be-afraid-to-commit.readthedocs.io/en/latest/documentation.html.
A partir do momento em que for evoluindo na minha tarefa vou submentendo novos PR e atualizando a documentação.
Também quero perguntar se existe algum caminho que você deseja que eu siga pois como mantenedor do pacote será mais fácil me informar o "norte" a ser seguido.