You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
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.
The text was updated successfully, but these errors were encountered:
Describe the bug
Parameters with a default value of type Tuple don't render correctly in our docs. See the missing parentheses around
'0100'
forlogical_records
here: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.
The text was updated successfully, but these errors were encountered: