Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

overloaded functions have several signatures in the docs #4487

Closed
mathause opened this issue Oct 5, 2020 · 5 comments · Fixed by #4606
Closed

overloaded functions have several signatures in the docs #4487

mathause opened this issue Oct 5, 2020 · 5 comments · Fixed by #4606

Comments

@mathause
Copy link
Collaborator

mathause commented Oct 5, 2020

See

image

(http://xarray.pydata.org/en/latest/generated/xarray.concat.html)

Can this be fixed? Or do we actually want to show both?

@keewis
Copy link
Collaborator

keewis commented Oct 5, 2020

Good catch, @mathause.

I don't think we should show type hints at all (they're not visible in the API pages without @overload), that's what the parameter documentation is for. To solve this, I'd look for a configuration setting for autosummary / autodoc (I think the latter generates the signature) or try to figure out if that's a bug / missing feature in autodoc.

@mathause
Copy link
Collaborator Author

mathause commented Oct 5, 2020

@keewis
Copy link
Collaborator

keewis commented Oct 5, 2020

that's already set:

autodoc_typehints = "none"
so I guess this is a missing feature for autodoc. sphinx-doc/sphinx#7785, maybe?

@mathause
Copy link
Collaborator Author

mathause commented Oct 6, 2020

Yes, does sound like the issue. I guess we'll have to wait for upstream...

@keewis
Copy link
Collaborator

keewis commented Nov 23, 2020

this is fixed in sphinx=3.3.0, so updating the pinned version in doc.yml should be enough

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants