update docstrings so that sphinx don't throw warnings anymore #983
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
evgeni
commented
Sep 28, 2020
| params (dict): Lookup parameters (i.e. parent_id for nested entities) (optional) | ||
| foreman_spec (dict): Description of the entity structure | ||
| Return value: | ||
| The new current state if the entity |
There was a problem hiding this comment.
I took the liberty to fix that typo XD
evgeni
commented
Sep 28, 2020
Comment on lines
871
to
872
| :return: The new current state of the entity | ||
| :rtype: dict |
There was a problem hiding this comment.
this is IMHO wrong, the method returns None
There was a problem hiding this comment.
With None being "the new state of the entity", so it is technically NoneType, but we always meant Union(NoneType, dict).
There was a problem hiding this comment.
So that's also what sphinx-doc/sphinx#1874 recommends and I've implemented it now ;)
mdellweg
approved these changes
Sep 28, 2020
it's still not perfect, but much better
evgeni
force-pushed
the
docstring-formatting
branch
from
c8aa258
to
6a9afeb
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
it's still not perfect, but much better