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

BUG: tuple default argument representation #8052

Closed
larsoner opened this issue Aug 4, 2020 · 1 comment
Closed

BUG: tuple default argument representation #8052

larsoner opened this issue Aug 4, 2020 · 1 comment
Labels

Comments

@larsoner
Copy link
Contributor

larsoner commented Aug 4, 2020

Describe the bug
Documenting a function with def func(x=(1, 2)) shows up as def func(x=1, 2) when processed by Sphinx.

According to a git bisect this regression was introduced by c4d7f4d

To Reproduce
From numpy/numpydoc#291, steps to reproduce the behavior:

$ git clone https://github.com/larsoner/numpydoc
$ cd numpydoc
$ git checkout -b tuple origin/tuple
$ cd numpydoc/tests/tinybuild
$ make
<click on my_function in the built doc that pops up>

Screenshots

On commit 822625d (correct):

Screenshot from 2020-08-04 11-56-23

On commit c4d7f4d (incorrect):

Screenshot from 2020-08-04 12-02-19

Environment info

  • OS: Linunx
  • Python version: 3.8
  • Sphinx version: above
  • Sphinx extensions: numpydoc, autodoc, autosummary
@larsoner
Copy link
Contributor Author

larsoner commented Oct 7, 2020

Looks like this was fixed by #8265

@larsoner larsoner closed this as completed Oct 7, 2020
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 19, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant