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

Explain in the development guidelines how to write good docstrings #191

Closed
lars-reimann opened this issue Apr 14, 2023 · 1 comment · Fixed by #226
Closed

Explain in the development guidelines how to write good docstrings #191

lars-reimann opened this issue Apr 14, 2023 · 1 comment · Fixed by #226
Assignees
@lars-reimann
Labels
documentation 📖 Improvements or additions to documentation released Included in a release

Comments

@lars-reimann
Copy link
Member

lars-reimann commented Apr 14, 2023 •
edited
Loading

We should have a longer section in the development guidelines about docstrings. Some things that should be included:
@lars-reimann lars-reimann added the documentation 📖 Improvements or additions to documentation label Apr 14, 2023
@github-project-automation github-project-automation bot moved this to Backlog in Library Apr 14, 2023
@lars-reimann lars-reimann mentioned this issue Apr 14, 2023
Closed
@lars-reimann lars-reimann self-assigned this Apr 19, 2023
@lars-reimann lars-reimann moved this from Backlog to Todo in Library Apr 21, 2023
@lars-reimann lars-reimann moved this from Todo to In Progress in Library Apr 21, 2023
@lars-reimann lars-reimann linked a pull request Apr 21, 2023 that will close this issue
docs: better guidance on how to write docstrings #226
Merged
@lars-reimann lars-reimann mentioned this issue Apr 21, 2023
Merged
lars-reimann added a commit that referenced this issue Apr 21, 2023
@lars-reimann
docs: better guidance on how to write docstrings (#226)
e3b9feb 
Closes #191.

### Summary of Changes

Improve guidelines how to write good docstrings.
@github-project-automation github-project-automation bot moved this from In Progress to ✔️ Done in Library Apr 21, 2023
@lars-reimann
Copy link
Member Author

🎉 This issue has been resolved in version 0.12.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@lars-reimann lars-reimann added the released Included in a release label May 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lars-reimann lars-reimann

Labels
documentation 📖 Improvements or additions to documentation released Included in a release
Projects
Library
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: better guidance on how to write docstrings Safe-DS/Library
1 participant
@lars-reimann