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

Remove type hints from parameters & results in docstrings #58

Closed
lars-reimann opened this issue Jan 25, 2024 · 1 comment · Fixed by #132
Closed

Remove type hints from parameters & results in docstrings #58

lars-reimann opened this issue Jan 25, 2024 · 1 comment · Fixed by #132
Assignees
@lars-reimann
Labels
documentation 📖 Improvements or additions to documentation released Included in a release

Comments

@lars-reimann
Copy link
Member

mkdocstring is able to understand type hints in the code as well now, so there is no reason to duplicate this information in the docstrings. Thus, it makes sense to remove this redundancy.

The project guidelines should also be updated as done here.
@lars-reimann lars-reimann added the documentation 📖 Improvements or additions to documentation label Jan 25, 2024
@lars-reimann lars-reimann self-assigned this May 4, 2024
@lars-reimann lars-reimann linked a pull request May 4, 2024 that will close this issue
docs: adjust descriptions of parameters and results to styleguide #132
Merged
@lars-reimann lars-reimann mentioned this issue May 4, 2024
Merged
lars-reimann added a commit that referenced this issue May 4, 2024
@lars-reimann
docs: adjust descriptions of parameters and results to styleguide (#132)
5f57bae 
Closes #58

### Summary of Changes

Remove types of parameters and results in docstrings. This easily lead
to inconsistencies.
@github-project-automation github-project-automation bot moved this from Backlog to ✔️ Done in Library Analysis May 4, 2024
@lars-reimann
Copy link
Member Author

🎉 This issue has been resolved in version 0.3.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@lars-reimann lars-reimann added the released Included in a release label May 4, 2024
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 Analysis
Status: ✔️ Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: adjust descriptions of parameters and results to styleguide Safe-DS/Stub-Generator
1 participant
@lars-reimann