Skip to content
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.

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

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

Closed
timhoffm opened this issue May 24, 2023 · 6 comments · Fixed by #26801
Closed

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

timhoffm opened this issue May 24, 2023 · 6 comments · Fixed by #26801
Milestone

Comments

@timhoffm
Copy link
Member

Summary

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

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

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

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'?)
@EddieEngineers
Copy link

Hey Tim, I can put a PR in for this - keen to learn more about the Matplotlib library :)

@EddieEngineers
Copy link

Document that 'sci' and 'scientific' are equivalent. (Or maybe deprecate 'sci'?)

I'm not sure where the documentation is to update, do you mind pointing me in the right direction? :)

@rcomer
Copy link
Member

rcomer commented May 27, 2023

@EddieEngineers I think just in the method’s docstring.

@pedrompecanha
Copy link
Contributor

pedrompecanha commented Sep 12, 2023

Hi guys! If I understood correctly, a method has inconsistent default values, and a lack of documentation. I saw that the previous attempt didn't continue until the end, and @timhoffm said he could take it over. Could I take it over and solve the issues? It would be a brilliant opportunity for me to learn and start to get used to the project. It would really, really mean much to me. Thanks in advance!

@timhoffm
Copy link
Member Author

@pedrompecanha Go for it!

@pedrompecanha
Copy link
Contributor

Done @timhoffm! Thank you for the encouragement. I'll be ready to fix anything related to my PR relatively quickly!

@QuLogic QuLogic added this to the v3.9.0 milestone Sep 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants