Skip to content

[MNT]: Cleanup ticklabel_format(..., style=) #25974

New issue
New issue
Closed
#26801
Closed
[MNT]: Cleanup ticklabel_format(..., style=)#25974
#26801
Labels
Maintenance
Milestone
v3.9.0
@timhoffm

Description

@timhoffm
timhoffm
opened on May 24, 2023

Summary

Half a note to self, but anybody can pick this up.

matplotlib/lib/matplotlib/axes/_base.py

Line 3191 in 6a323c0

def ticklabel_format(self, *, axis='both', style='', scilimits=None,

defaults style='', which is only used at:

matplotlib/lib/matplotlib/axes/_base.py

Lines 3245 to 3246 in 6a323c0

STYLES = {'sci': True, 'scientific': True, 'plain': False, '': None}
is_sci_style = _api.check_getitem(STYLES, style=style)

Proposed fix

  • Consistency: Change the default value to None, like for all the other kwargs here, which has the sematincs None = do not change.
  • Document that 'sci' and 'scientific' are equivalent. (Or maybe deprecate 'sci'?)

Metadata

Metadata

Assignees

No one assigned

    Labels

    Maintenance

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions