Skip to content

Conversation

@keewis
Copy link
Collaborator

@keewis keewis commented May 16, 2020

The reason for those fragments is that napoleon and numpydoc somehow conflict with each other. From a quick glance I couldn't find anything that breaks without numpydoc, but I might be missing something.

For reference, here's the new API page.

keewis added 2 commits May 16, 2020 13:14
which is the reason for the backslash-escaped stars
@dcherian
Copy link
Contributor

Nice! the apply-ufunc signature is readable again. Should close #3178

image

@keewis
Copy link
Collaborator Author

keewis commented May 16, 2020

is the (seemingly random) distributed failure a known issue?

@keewis
Copy link
Collaborator Author

keewis commented May 16, 2020

there is a difference between the versions with and without numpydoc: the reference pages for the ufuncs don't show the signature. Since that would always have been (*args, **kwargs) we don't lose anything, I guess?

@max-sixty
Copy link
Collaborator

Great! Thanks @keewis !

@dcherian
Copy link
Contributor

: the reference pages for the ufuncs don't show the signature.

I think this is a relatively minor issue for a really large improvement in signatures for other functions

@keewis
Copy link
Collaborator Author

keewis commented May 19, 2020

if there are no issues without numpydoc, should we merge?

@dcherian
Copy link
Contributor

SOudns good to me!

@keewis keewis merged commit f38b0c1 into pydata:master May 19, 2020
@keewis keewis deleted the fix-signature-escapes branch May 19, 2020 16:49
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.

type annotations make docs confusing

3 participants