Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOC: Automatic default rcParam expansion creates misleading sentences #15232

Closed
@QuLogic

Description

@QuLogic

Looking at the changes in #15230, the fact that = produces valid code (as argued in #15115) seems to be a point against using it. Many sentences appear to use constructs like:

Use :rc:`something` to do something.

or

You can do something by setting :rc:`something`.

These will become:

Use rcParams[something] = "default" to do something.

or

You can do something by setting rcParams[something] = "default".

This implies that you should set the rcParam to its default value, but those sentence often just mean set it to anything.

Originally posted by @QuLogic in #15115 (comment)

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocumentationRelease criticalFor bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions.

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions