Remove unnecessary paths from Sphinx directives. #132
Merged
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
|
|
||
| .. autoclass:: Either | ||
| :members: | ||
| :exclude-members: except_, else_, otherwise, alternatively, failing_that |
There was a problem hiding this comment.
For my knowledge; what does this do?
There was a problem hiding this comment.
This tells autodoc-sphinx to not add these methods to the auto-generated documentation.
There was a problem hiding this comment.
These methods are the aliases of the original method, so it will just say the same thing N times, which is very confusing to read in my opinion. We document the aliases in the docstring of the original, so they will show. Here's what it looks like now:
here's what it looks like after the PR:
|
Looks like mypy doesn't currently support aliases this way. |
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.
I just found out yesterday that when you're in the class, you don't need to supply the path to the method! You can just do
Life-changing. But more life-changing is our decision to document aliases differently, mentioning them in the base class and skipping their documentation in the ... documentation. This PR does both of those things!