diff options
| author | Jenkins <jenkins@review.openstack.org> | 2013-05-17 21:16:08 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2013-05-17 21:16:08 +0000 |
| commit | 55ccdbc3bc62dc32161112a77c0fed39e73ee7b4 (patch) | |
| tree | a37ef87fd5ddd0e1feed9bc1e852bd4a0a703d49 /doc/source | |
| parent | 580c6c399ab18c92da6563fd1f851a74306e0a97 (diff) | |
| parent | 2dce8c92f6cfc4fb5d6a455fe13cbc0ed6d72882 (diff) | |
| download | nova-55ccdbc3bc62dc32161112a77c0fed39e73ee7b4.tar.gz nova-55ccdbc3bc62dc32161112a77c0fed39e73ee7b4.tar.xz nova-55ccdbc3bc62dc32161112a77c0fed39e73ee7b4.zip | |
Merge "Remove usage of locals() for formatting from nova.api.*"
Diffstat (limited to 'doc/source')
| -rw-r--r-- | doc/source/devref/il8n.rst | 13 |
1 files changed, 5 insertions, 8 deletions
diff --git a/doc/source/devref/il8n.rst b/doc/source/devref/il8n.rst index 900ea8a28..3b5ea65e9 100644 --- a/doc/source/devref/il8n.rst +++ b/doc/source/devref/il8n.rst @@ -9,14 +9,11 @@ in a ``_()`` function call. For example:: LOG.debug(_("block_device_mapping %s"), block_device_mapping) -If you have multiple arguments, the convention is to use named parameters. -It's common to use the ``locals()`` dict (which contains the names and values -of the local variables in the current scope) to do the string interpolation. -For example:: - - label = ... - sr_ref = ... - LOG.debug(_('Introduced %(label)s as %(sr_ref)s.') % locals()) +Do not use ``locals()`` for formatting messages because: +1. It is not as clear as using explicit dicts. +2. It could produce hidden errors during refactoring. +3. Changing the name of a variable causes a change in the message. +4. It creates a lot of otherwise unused variables. If you do not follow the project conventions, your code may cause the LocalizationTestCase.test_multiple_positional_format_placeholders test to fail |