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

* added a note to avoid f-strings in logging ------ Co-authored-by: Jody Klymak <jklymak@gmail.com>
stefmolin · Mar 6, 2023 · c0eb43e · c0eb43e
1 parent bdb4935
commit c0eb43e
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/doc/devel/contributing.rst b/doc/devel/contributing.rst
@@ -455,6 +455,12 @@ Then they will receive messages like
    DEBUG:matplotlib.yourmodulename:Here is some information
    DEBUG:matplotlib.yourmodulename:Here is some more detailed information
 
+Avoid using pre-computed strings (``f-strings``, ``str.format``,etc.) for logging because of security and
+performance issues, and because they interfere with style handlers. For example, use ``_log.error('hello %s', 'world')``  rather than
+``_log.error('hello {}'.format('world'))`` or ``_log.error(f'hello {s}')``.
+
+
+
 Which logging level to use?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~