remove the backslash escapes and typehint fragments in the API docs#4070
Merged
keewis merged 2 commits intopydata:masterfrom May 19, 2020
Merged
remove the backslash escapes and typehint fragments in the API docs#4070keewis merged 2 commits intopydata:masterfrom
keewis merged 2 commits intopydata:masterfrom
Conversation
which is the reason for the backslash-escaped stars
Contributor
|
Nice! the apply-ufunc signature is readable again. Should close #3178 |
Collaborator
Author
|
is the (seemingly random) |
Collaborator
Author
|
there is a difference between the versions with and without |
Collaborator
|
Great! Thanks @keewis ! |
Contributor
I think this is a relatively minor issue for a really large improvement in signatures for other functions |
Collaborator
Author
|
if there are no issues without |
Contributor
|
SOudns good to me! |
This file contains hidden or 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
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.

The reason for those fragments is that
napoleonandnumpydocsomehow conflict with each other. From a quick glance I couldn't find anything that breaks withoutnumpydoc, but I might be missing something.For reference, here's the new API page.
isort -rc . && black . && mypy . && flake8