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

Tuple default values render without parentheses on RTD #1284

Closed
kandersolar opened this issue Aug 16, 2021 · 0 comments · Fixed by #1435
Closed

Tuple default values render without parentheses on RTD #1284

kandersolar opened this issue Aug 16, 2021 · 0 comments · Fixed by #1435
Milestone

Comments

@kandersolar
Copy link
Member

Describe the bug
Parameters with a default value of type Tuple don't render correctly in our docs. See the missing parentheses around '0100' for logical_records here:

image

Note that the default value for logical_records is definitely a tuple in the source code.

This is a known sphinx bug (see sphinx-doc/sphinx#7964 and sphinx-doc/sphinx#9364) that I think is fixed as of sphinx 4.1.0 (release notes). We are currently on 3.1.2 so there's a decent chance something else will break when we bump the version, so we'll need to review the rest of the docs to make sure things are still looking good when we do that.

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.

1 participant