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.

Sign up for GitHub

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

Jump to bottom

Decidir o formato padrão para doscstrings no repositório #68

Open
augusto-herrmann opened this issue May 18, 2022 · 1 comment
Open

Decidir o formato padrão para doscstrings no repositório #68

augusto-herrmann opened this issue May 18, 2022 · 1 comment

Comments

@augusto-herrmann
Copy link
Member

augusto-herrmann commented May 18, 2022 •
edited
Loading

Precisamos decidir um formato padrão para usar nas docstrings do repositório, documentá-lo nas instruções de contribuição e adaptar as docstrings em todos os módulos Python para que fiquem em conformidade com essa decisão.

Algumas possibilidades de estilo de docstring:

A PEP 287 recomenda o estilo reST. Porém muitos módulos deste repositório já estão usando Google style docstrings.

Mais informações:
@augusto-herrmann augusto-herrmann changed the title Decidir o formato padrão para doscstringsno repositório Decidir o formato padrão para doscstrings no repositório May 18, 2022
@augusto-herrmann augusto-herrmann mentioned this issue May 18, 2022
Merged
@augusto-herrmann
Copy link
Member Author

augusto-herrmann commented Apr 15, 2023 •
edited
Loading

We've been using Google style docstrings for a while now. But let's leave this open until this is coded into a CONTRIBUTING.md file (issue #4).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@augusto-herrmann