Merge pull request #120 from vianney-g/master

Add logger parameters antipattern

Author: adewes

docs/correctness/not_letting_logger_format_messages.rst

@@ -0,0 +1,31 @@
+Not letting logger format messages
+----------------------------------
+
+When you log a message, do not format your message with parameters. You should
+let logger lib handle that.
+
+
+Anti-pattern
+------------
+
+.. code:: python
+    msg = "Error %s catched!"
+    logger.error(msg % 1337)
+
+
+Best practice(s)
+----------------
+
+Let logger format message
+.........................
+
+Pass message parameters as arguments to the logger function.
+
+.. code:: python
+    msg = "Error %s catched!"
+    logger.error(msg,  1337)
+
+
+References
+----------
+- `Python logging howto <https://docs.python.org/3/howto/logging.html#logging-variable-data>`_