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

added a note to avoid f-strings in logging #25081

Merged
merged 5 commits into from
Mar 6, 2023
Merged

added a note to avoid f-strings in logging #25081

merged 5 commits into from
Mar 6, 2023

Conversation

muddi900
Copy link
Contributor

PR Summary

As per #25080, a note has been added to the contributing.rst

PR Checklist

Documentation and Tests

  • Has pytest style unit tests (and pytest passes)
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • New plotting related features are documented with examples.

Release Notes

  • New features are marked with a .. versionadded:: directive in the docstring and documented in doc/users/next_whats_new/
  • API changes are marked with a .. versionchanged:: directive in the docstring and documented in doc/api/next_api_changes/
  • Release notes conform with instructions in next_whats_new/README.rst or next_api_changes/README.rst

@tacaswell
Copy link
Member

@muddi900 Would you also be willing to add an example of how it should be done to the examples?

It is not just fstrings, it is any "pre-computed" formatting that is the problem.

@rcomer rcomer linked an issue Jan 25, 2023 that may be closed by this pull request
@muddi900
Copy link
Contributor Author

I'll ammend ot on the next day or so.

@jklymak jklymak marked this pull request as draft January 26, 2023 02:11
@tacaswell tacaswell modified the milestone: v3.8.0 Jan 26, 2023
doc/devel/contributing.rst Outdated Show resolved Hide resolved
doc/devel/contributing.rst Outdated Show resolved Hide resolved
doc/devel/contributing.rst Outdated Show resolved Hide resolved
@QuLogic
Copy link
Member

QuLogic commented Feb 21, 2023

Is this complete? Please mark the PR as Ready for review if so.

@muddi900 muddi900 marked this pull request as ready for review February 22, 2023 04:55
doc/devel/contributing.rst Outdated Show resolved Hide resolved
doc/devel/contributing.rst Outdated Show resolved Hide resolved
@jklymak
Copy link
Member

jklymak commented Feb 25, 2023

You are failing a check in pre-commit.ci.

muddi900 and others added 3 commits February 27, 2023 06:53
added code blocks of examples and changed to pre-computed

fixed code-block formatting

More gramar and format fixes
Co-authored-by: Jody Klymak <jklymak@gmail.com>
Co-authored-by: Jody Klymak <jklymak@gmail.com>
doc/devel/contributing.rst Outdated Show resolved Hide resolved
@rcomer
Copy link
Member

rcomer commented Mar 5, 2023

pre-commit.ci autofix

@rcomer
Copy link
Member

rcomer commented Mar 6, 2023

Docs build has now passed and the section looks like this.

@jklymak jklymak merged commit c0eb43e into matplotlib:main Mar 6, 2023
@jklymak
Copy link
Member

jklymak commented Mar 6, 2023

Thanks @muddi900 !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

Add note in contrib guide admonishing against use of f strings in logs
7 participants