Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 0bf4d89

Browse files
committed
add warning about strop
1 parent dc46c7f commit 0bf4d89

2 files changed

Lines changed: 30 additions & 14 deletions

File tree

Doc/lib/libstring.tex

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,11 @@ \section{Standard Module \sectcode{string}}
33
\stmodindex{string}
44

55
This module defines some constants useful for checking character
6-
classes, some exceptions, and some useful string functions.
7-
The constants are:
6+
classes and some useful string functions. See the modules
7+
\code{regex} and \code{regsub} for string functions based on regular
8+
expressions.
9+
10+
The constants defined in this module are are:
811

912
\renewcommand{\indexsubitem}{(data in module string)}
1013
\begin{datadesc}{digits}
@@ -48,11 +51,7 @@ \section{Standard Module \sectcode{string}}
4851
undefined.
4952
\end{datadesc}
5053

51-
The exceptions are:
52-
53-
\renewcommand{\indexsubitem}{(exception in module string)}
54-
55-
The functions are:
54+
The functions defined in this module are:
5655

5756
\renewcommand{\indexsubitem}{(in module string)}
5857

@@ -169,3 +168,12 @@ \section{Standard Module \sectcode{string}}
169168
Pad a numeric string on the left with zero digits until the given
170169
width is reached. Strings starting with a sign are handled correctly.
171170
\end{funcdesc}
171+
172+
This module is implemented in Python. Much of its functionality has
173+
been reimplemented in the built-in module \code{strop}. However, you
174+
should \emph{never} import the latter module directly. When
175+
\code{string} discovers that \code{strop} exists, it transparently
176+
replaces parts of itself with the implementation from \code{strop}.
177+
After initialization, there is \emph{no} overhead in using
178+
\code{string} instead of \code{strop}.
179+
\bimodindex{strop}

Doc/libstring.tex

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,11 @@ \section{Standard Module \sectcode{string}}
33
\stmodindex{string}
44

55
This module defines some constants useful for checking character
6-
classes, some exceptions, and some useful string functions.
7-
The constants are:
6+
classes and some useful string functions. See the modules
7+
\code{regex} and \code{regsub} for string functions based on regular
8+
expressions.
9+
10+
The constants defined in this module are are:
811

912
\renewcommand{\indexsubitem}{(data in module string)}
1013
\begin{datadesc}{digits}
@@ -48,11 +51,7 @@ \section{Standard Module \sectcode{string}}
4851
undefined.
4952
\end{datadesc}
5053

51-
The exceptions are:
52-
53-
\renewcommand{\indexsubitem}{(exception in module string)}
54-
55-
The functions are:
54+
The functions defined in this module are:
5655

5756
\renewcommand{\indexsubitem}{(in module string)}
5857

@@ -169,3 +168,12 @@ \section{Standard Module \sectcode{string}}
169168
Pad a numeric string on the left with zero digits until the given
170169
width is reached. Strings starting with a sign are handled correctly.
171170
\end{funcdesc}
171+
172+
This module is implemented in Python. Much of its functionality has
173+
been reimplemented in the built-in module \code{strop}. However, you
174+
should \emph{never} import the latter module directly. When
175+
\code{string} discovers that \code{strop} exists, it transparently
176+
replaces parts of itself with the implementation from \code{strop}.
177+
After initialization, there is \emph{no} overhead in using
178+
\code{string} instead of \code{strop}.
179+
\bimodindex{strop}

0 commit comments

Comments
 (0)