Fix markup.

This commit is contained in:
Georg Brandl 2012-03-15 08:23:23 +01:00
parent 3153cd2e37
commit d8498d616a
1 changed files with 8 additions and 7 deletions

View File

@ -543,12 +543,12 @@ Prescriptive: Naming Conventions
Names to Avoid
~~~~~~~~~~~~~~
Never use the characters `l' (lowercase letter el), `O' (uppercase
letter oh), or `I' (uppercase letter eye) as single character variable
Never use the characters 'l' (lowercase letter el), 'O' (uppercase
letter oh), or 'I' (uppercase letter eye) as single character variable
names.
In some fonts, these characters are indistinguishable from the
numerals one and zero. When tempted to use `l', use `L' instead.
numerals one and zero. When tempted to use 'l', use 'L' instead.
Package and Module Names
~~~~~~~~~~~~~~~~~~~~~~~~
@ -588,10 +588,11 @@ Global Variable Names
(Let's hope that these variables are meant for use inside one module
only.) The conventions are about the same as those for functions.
Modules that are designed for use via "from M import *" should use the
``__all__`` mechanism to prevent exporting globals, or use the older
convention of prefixing such globals with an underscore (which you
might want to do to indicate these globals are "module non-public").
Modules that are designed for use via ``from M import *`` should use
the ``__all__`` mechanism to prevent exporting globals, or use the
older convention of prefixing such globals with an underscore (which
you might want to do to indicate these globals are "module
non-public").
Function Names
~~~~~~~~~~~~~~