Skip to content

docs: clean up docstrings#628

Merged
DaniBodor merged 1 commit intodevfrom
627_docstring_cleanup_dbodor
Jul 12, 2024
Merged

docs: clean up docstrings#628
DaniBodor merged 1 commit intodevfrom
627_docstring_cleanup_dbodor

Conversation

@DaniBodor
Copy link
Copy Markdown
Collaborator

@DaniBodor DaniBodor commented Jul 12, 2024

This was pretty fast to do, and looks much neater.

Mainly removed expected types from docstrings when they were given as type hints in the arguments of the function.
In many cases also moved the default for an argument to the end of the same line
In a few cases actually fixed an error in a docstring or improved the explanation

fix: #627

@DaniBodor DaniBodor requested a review from gcroci2 July 12, 2024 11:02
@DaniBodor DaniBodor linked an issue Jul 12, 2024 that may be closed by this pull request
@DaniBodor DaniBodor merged commit 1922c70 into dev Jul 12, 2024
@DaniBodor DaniBodor deleted the 627_docstring_cleanup_dbodor branch July 12, 2024 13:11
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.

Remove types from docstrings

2 participants