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

Be more consistent in the docstrings regarding the argument types #1150

Closed
medihack opened this issue Aug 8, 2024 · 0 comments · Fixed by #1153
Closed

Be more consistent in the docstrings regarding the argument types #1150

medihack opened this issue Aug 8, 2024 · 0 comments · Fixed by #1153
Labels
Issue appropriate for: newcomers 🤩 This issue can be safely tackled by people who never worked in this project before Issue contains: Some documentation 📚 This issues involves writing some documentation Issue contains: Some Python 🐍 This issue involves writing some Python code PR type: documentation 📚 Contains documentation updates
Milestone
Version 3.0

Comments

@medihack
Copy link
Member

medihack commented Aug 8, 2024

We need to be more consistent in the docstrings regarding the argument types. I believe they're not needed and sphinx can read them from type annotations, but we should make sure of that and fix it everywhere.

Originally posted by @ewjoachim in #1146 (comment)
@medihack medihack added Issue appropriate for: newcomers 🤩 This issue can be safely tackled by people who never worked in this project before Issue contains: Some documentation 📚 This issues involves writing some documentation Issue contains: Some Python 🐍 This issue involves writing some Python code PR type: documentation 📚 Contains documentation updates labels Aug 8, 2024
@medihack medihack added this to the Version 3.0 milestone Aug 8, 2024
@ewjoachim ewjoachim mentioned this issue Aug 11, 2024
Merged
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Issue appropriate for: newcomers 🤩 This issue can be safely tackled by people who never worked in this project before Issue contains: Some documentation 📚 This issues involves writing some documentation Issue contains: Some Python 🐍 This issue involves writing some Python code PR type: documentation 📚 Contains documentation updates
Projects
None yet
Milestone
Version 3.0
Development

Successfully merging a pull request may close this issue.

Remove sphinx-autodoc-typehints, upgrade Myst & Sphinx procrastinate-org/procrastinate
1 participant
@medihack