summaryrefslogtreecommitdiffstats
path: root/Doc/howto
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2007-12-29 10:57:00 (GMT)
committerGeorg Brandl <georg@python.org>2007-12-29 10:57:00 (GMT)
commitb19be571e09263239ef29c92eee06dbb30186685 (patch)
tree9c8a5439b14ce34cfaa0e4e164483b0f8690aa42 /Doc/howto
parent28c7bcf38e1e69a9091cbba90b982331428ddbe6 (diff)
downloadcpython-b19be571e09263239ef29c92eee06dbb30186685.zip
cpython-b19be571e09263239ef29c92eee06dbb30186685.tar.gz
cpython-b19be571e09263239ef29c92eee06dbb30186685.tar.bz2
Some cleanup in the docs.
Diffstat (limited to 'Doc/howto')
-rw-r--r--Doc/howto/advocacy.rst16
-rw-r--r--Doc/howto/doanddont.rst2
-rw-r--r--Doc/howto/regex.rst34
3 files changed, 17 insertions, 35 deletions
diff --git a/Doc/howto/advocacy.rst b/Doc/howto/advocacy.rst
index 1f1754a..7d7706e 100644
--- a/Doc/howto/advocacy.rst
+++ b/Doc/howto/advocacy.rst
@@ -302,11 +302,11 @@ http://www.pythonology.com/success
The Python Success Stories are a collection of stories from successful users of
Python, with the emphasis on business and corporate users.
-.. % \term{\url{http://www.fsbassociates.com/books/pythonchpt1.htm}}
-.. % The first chapter of \emph{Internet Programming with Python} also
-.. % examines some of the reasons for using Python. The book is well worth
-.. % buying, but the publishers have made the first chapter available on
-.. % the Web.
+.. http://www.fsbassociates.com/books/pythonchpt1.htm
+ The first chapter of \emph{Internet Programming with Python} also
+ examines some of the reasons for using Python. The book is well worth
+ buying, but the publishers have made the first chapter available on
+ the Web.
http://home.pacbell.net/ouster/scripting.html
John Ousterhout's white paper on scripting is a good argument for the utility of
@@ -333,9 +333,9 @@ http://pythonjournal.cognizor.com/pyj1/Everitt-Feit_interview98-V1.html
to show that choosing Python didn't introduce any difficulties into a company's
development process, and provided some substantial benefits.
-.. % \term{\url{http://www.python.org/psa/Commercial.html}}
-.. % Robin Friedrich wrote this document on how to support Python's use in
-.. % commercial projects.
+.. http://www.python.org/psa/Commercial.html
+ Robin Friedrich wrote this document on how to support Python's use in
+ commercial projects.
http://www.python.org/workshops/1997-10/proceedings/stein.ps
For the 6th Python conference, Greg Stein presented a paper that traced Python's
diff --git a/Doc/howto/doanddont.rst b/Doc/howto/doanddont.rst
index 600c216..a350753 100644
--- a/Doc/howto/doanddont.rst
+++ b/Doc/howto/doanddont.rst
@@ -290,7 +290,7 @@ are often more then is comfortable to put in one line, many people do::
calculate_number(10, 20) != forbulate(500, 360):
pass
-You should realize that this is dangerous: a stray space after the ``XXX`` would
+You should realize that this is dangerous: a stray space after the ``\`` would
make this line wrong, and stray spaces are notoriously hard to see in editors.
In this case, at least it would be a syntax error, but if the code was::
diff --git a/Doc/howto/regex.rst b/Doc/howto/regex.rst
index 131bb51..e237e6c 100644
--- a/Doc/howto/regex.rst
+++ b/Doc/howto/regex.rst
@@ -5,11 +5,11 @@
:Author: A.M. Kuchling
:Release: 0.05
-.. % TODO:
-.. % Document lookbehind assertions
-.. % Better way of displaying a RE, a string, and what it matches
-.. % Mention optional argument to match.groups()
-.. % Unicode (at least a reference)
+.. TODO:
+ Document lookbehind assertions
+ Better way of displaying a RE, a string, and what it matches
+ Mention optional argument to match.groups()
+ Unicode (at least a reference)
.. topic:: Abstract
@@ -91,8 +91,6 @@ is the same as ``[a-c]``, which uses a range to express the same set of
characters. If you wanted to match only lowercase letters, your RE would be
``[a-z]``.
-.. % $
-
Metacharacters are not active inside classes. For example, ``[akm$]`` will
match any of the characters ``'a'``, ``'k'``, ``'m'``, or ``'$'``; ``'$'`` is
usually a metacharacter, but inside a character class it's stripped of its
@@ -679,8 +677,8 @@ given location, they can obviously be matched an infinite number of times.
>>> print re.search('^From', 'Reciting From Memory')
None
- .. % To match a literal \character{\^}, use \regexp{\e\^} or enclose it
- .. % inside a character class, as in \regexp{[{\e}\^]}.
+ .. To match a literal \character{\^}, use \regexp{\e\^} or enclose it
+ .. inside a character class, as in \regexp{[{\e}\^]}.
``$``
Matches at the end of a line, which is defined as either the end of the string,
@@ -696,8 +694,6 @@ given location, they can obviously be matched an infinite number of times.
To match a literal ``'$'``, use ``\$`` or enclose it inside a character class,
as in ``[$]``.
- .. % $
-
``\A``
Matches only at the start of the string. When not in :const:`MULTILINE` mode,
``\A`` and ``^`` are effectively the same. In :const:`MULTILINE` mode, they're
@@ -980,12 +976,8 @@ filenames where the extension is not ``bat``? Some incorrect attempts:
that the first character of the extension is not a ``b``. This is wrong,
because the pattern also doesn't match ``foo.bar``.
-.. % $
-
``.*[.]([^b]..|.[^a].|..[^t])$``
-.. % Messes up the HTML without the curly braces around \^
-
The expression gets messier when you try to patch up the first solution by
requiring one of the following cases to match: the first character of the
extension isn't ``b``; the second character isn't ``a``; or the third character
@@ -1013,16 +1005,12 @@ match, the whole pattern will fail. The trailing ``$`` is required to ensure
that something like ``sample.batch``, where the extension only starts with
``bat``, will be allowed.
-.. % $
-
Excluding another filename extension is now easy; simply add it as an
alternative inside the assertion. The following pattern excludes filenames that
end in either ``bat`` or ``exe``:
``.*[.](?!bat$|exe$).*$``
-.. % $
-
Modifying Strings
=================
@@ -1343,16 +1331,10 @@ enables REs to be formatted more neatly::
\s*$ # Trailing whitespace to end-of-line
""", re.VERBOSE)
-This is far more readable than:
-
-.. % $
-
-::
+This is far more readable than::
pat = re.compile(r"\s*(?P<header>[^:]+)\s*:(?P<value>.*?)\s*$")
-.. % $
-
Feedback
========