Merge "Updating HACKING to disallow the use of locals()"

2013-05-31 13:45:54 +00:00 · 2013-05-31 13:45:54 +00:00 · 8ed6644cb8
commit 8ed6644cb8
parent 984e889431 6251df9068
1 changed files with 9 additions and 0 deletions
--- a/HACKING.rst
+++ b/HACKING.rst
@ -46,6 +46,15 @@ General
    if not (X in Y or X in Z):  # OKAY, still better than all those 'not's
        pass

+- Do not use locals(). Example::
+
+    LOG.debug(_("volume %(vol_name)s: creating size %(vol_size)sG") %
+              locals()) # BAD
+
+    LOG.debug(_("volume %(vol_name)s: creating size %(vol_size)sG") %
+              {'vol_name': vol_name,
+               'vol_size': vol_size}) # OKAY
+

 Imports
 -------