summaryrefslogtreecommitdiffstats
path: root/Lib/regsub.py
diff options
context:
space:
mode:
authorGuido van Rossum <guido@python.org>2000-02-04 15:28:42 (GMT)
committerGuido van Rossum <guido@python.org>2000-02-04 15:28:42 (GMT)
commite7b146fb3bdca62a0d5ecc06dbf3348e5a4fe757 (patch)
treee1dda862f680cf4a1169220af2ecbca3322caf4d /Lib/regsub.py
parent54f22ed30bab2e64909ba2d79205cb4b87c69db2 (diff)
downloadcpython-e7b146fb3bdca62a0d5ecc06dbf3348e5a4fe757.zip
cpython-e7b146fb3bdca62a0d5ecc06dbf3348e5a4fe757.tar.gz
cpython-e7b146fb3bdca62a0d5ecc06dbf3348e5a4fe757.tar.bz2
The third and final doc-string sweep by Ka-Ping Yee.
The attached patches update the standard library so that all modules have docstrings beginning with one-line summaries. A new docstring was added to formatter. The docstring for os.py was updated to mention nt, os2, ce in addition to posix, dos, mac.
Diffstat (limited to 'Lib/regsub.py')
-rw-r--r--Lib/regsub.py16
1 files changed, 10 insertions, 6 deletions
diff --git a/Lib/regsub.py b/Lib/regsub.py
index 8fb3306..8e341bb 100644
--- a/Lib/regsub.py
+++ b/Lib/regsub.py
@@ -1,10 +1,14 @@
-# Regular expression subroutines:
-# sub(pat, repl, str): replace first occurrence of pattern in string
-# gsub(pat, repl, str): replace all occurrences of pattern in string
-# split(str, pat, maxsplit): split string using pattern as delimiter
-# splitx(str, pat, maxsplit): split string using pattern as delimiter plus
-# return delimiters
+"""Regexp-based split and replace using the obsolete regex module.
+This module is only for backward compatibility. These operations
+are now provided by the new regular expression module, "re".
+
+sub(pat, repl, str): replace first occurrence of pattern in string
+gsub(pat, repl, str): replace all occurrences of pattern in string
+split(str, pat, maxsplit): split string using pattern as delimiter
+splitx(str, pat, maxsplit): split string using pattern as delimiter plus
+ return delimiters
+"""
import regex