Skip to content

Tuple default values render without parentheses on RTD #1284

Closed
@kandersolar

Description

@kandersolar

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.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions