Docs: get rid of "Return type: None" for procedures with no return value #277
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
adamjstewart
force-pushed
the
docs/autodoc
branch
from
7aa2b6e to
c47c67c
Compare
adamjstewart
force-pushed
the
docs/autodoc
branch
from
c47c67c to
14e47bd
Compare
adamjstewart
changed the title
calebrob6
approved these changes
Dec 21, 2021
adamjstewart
added
utilities
yichiac
pushed a commit
to yichiac/torchgeo
that referenced
this pull request
Apr 29, 2023
…lue (microsoft#277) * Various improvements to API docs * Remove setting that is already the default
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.
Because we use mypy in strict mode, all methods must declare a return type. For procedures with no return value, this is None. Sphinx tries to document this by adding "Return type: None" to all procedures, but we don't really need this clutter. This PR removes that.