Skip to content

python-package documentation - #1773

Merged
aspeddro merged 11 commits into
masterfrom
docstring-documentation-cleanup
Sep 2, 2025
Merged

aspeddro merged 11 commits into
masterfrom
docstring-documentation-cleanup

Conversation

@aspeddro

@aspeddro aspeddro commented Aug 29, 2025 •

Copy link
Copy Markdown
Collaborator

Esse PR tem duas principais alterações:

  • Remove mkdocs e a pasta docs/
  • Atualiza docstrings de algumas funções e métodos
    • Usei IA para atualizar, formatar e remover type hint porque os tipos agora fica na definição da função
  • Remove o workflow deploy-docs
    • Não existe mais deploy

Tem um script gendoc.py que gera o arquivo markdown que será adicionado no repo website

Depois de mesclar esse PR podemos mesclar #1772.

Relacionado com basedosdados/website#1354

@rdahis

rdahis commented Aug 31, 2025

Copy link
Copy Markdown
Member

Não precisa atualizar o README né? Parece que só tem informação de instalação, ambiente, etc.

Comment thread README.md
- <img
src="https://github.com/gauravghongde/social-icons/blob/master/PNG/Color/Medium.png?raw=true"
width="15"> [Medium ↗](http://dev.to/basedosdados)
- [⚙️ Desenvolvimento](#desenvolvimento)

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Essa seção não existe

Comment thread Dockerfile Outdated

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dockerfile não é necessário, mkdocs foi removido

Comment thread docker-compose.yml Outdated

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mkdocs foi removido

@aspeddro

aspeddro commented Sep 1, 2025

Copy link
Copy Markdown
Collaborator Author

Teve poucas alterações no README. Envie mais alterações

Comment thread .github/CONTRIBUTING.md Outdated

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Esse arquivo está desatualizado. Estamos mantendo o CONTRIBUTING.md da raiz

@aspeddro
aspeddro merged commit 68ea68d into master Sep 2, 2025
4 checks passed
@aspeddro
aspeddro deleted the docstring-documentation-cleanup branch September 2, 2025 12:07
@aspeddro aspeddro added this to the python-package: 2.0.3 milestone Sep 17, 2025
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

Successfully merging this pull request may close these issues.

2 participants