8000 DOC: Automatic default rcParam expansion creates misleading sentences · Issue #15232 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

DOC: Automatic default rcParam expansion creates misleading sentences #15232

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.

Sign up for GitHub

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

Jump to bottom
Closed
QuLogic opened this issue Sep 9, 2019 · 2 comments · Fixed by #15244
Closed

DOC: Automatic default rcParam expansion creates misleading sentences #15232

QuLogic opened this issue Sep 9, 2019 · 2 comments · Fixed by #15244
Labels
Documentation Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions.
Milestone
v3.2.0

Comments

@QuLogic
Copy link
Member
QuLogic commented Sep 9, 2019

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)
@QuLogic QuLogic added this to the v3.2.0 milestone Sep 9, 2019
@jklymak
Copy link
Member
jklymak commented Sep 9, 2019

👍 Ideally math should be part of a proper sentence.

@timhoffm
Copy link
Member
timhoffm commented Sep 9, 2019

I propose to use the more verbose

rcParams[name] (default: Val)

to make it unambiguous.

@tacaswell tacaswell added the Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions. label Sep 10, 2019
@timhoffm timhoffm mentioned this issue Sep 10, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions.
Projects
None yet
Milestone
v3.2.0
Development

Successfully merging a pull request may close this issue.

Change documentation format of rcParams defaults timhoffm/matplotlib
4 participants
@tacaswell @QuLogic @jklymak @timhoffm
0