]> granicus.if.org Git - python/commitdiff
Use a {datadesc} environment to describe errorcode.
authorFred Drake <fdrake@acm.org>
Tue, 10 Mar 1998 03:53:03 +0000 (03:53 +0000)
committerFred Drake <fdrake@acm.org>
Tue, 10 Mar 1998 03:53:03 +0000 (03:53 +0000)
Doc/lib/liberrno.tex
Doc/liberrno.tex

index 507953d6e080dc3afe7e4493d2b05a778bc2ab4b..28f68c55d6d37f10380890cf4e0cba671b97d270 100644 (file)
@@ -2,21 +2,25 @@
 \label{module-errno}
 \stmodindex{errno}
 
-\setindexsubitem{(in module errno)}
 
 This module makes available standard errno system symbols.
 The value of each symbol is the corresponding integer value.
 The names and descriptions are borrowed from \file{linux/include/errno.h},
-which should be pretty all-inclusive.  Of the following list, symbols
-that are not used on the current platform are not defined by the
-module.
+which should be pretty all-inclusive.
 
-The module also defines the dictionary variable \code{errorcode} which
-maps numeric error codes back to their symbol names, so that e.g.
-\samp{errno.errorcode[errno.EPERM] == 'EPERM'}.  To translate a
-numeric error code to an error message, use \function{os.strerror()}.
+\begin{datadesc}{errorcode}
+  Dictionary providing a mapping from the errno value to the string
+  name in the underlying system.  For instance,
+  \code{errno.errorcode[errno.EPERM]} maps to \code{'EPERM'}.
+\end{datadesc}
+
+To translate a numeric error code to an error message, use
+\function{os.strerror()}.
+
+Of the following list, symbols that are not used on the current
+platform are not defined by the module.  Symbols available can
+include:
 
-Symbols available can include:
 \begin{datadesc}{EPERM} Operation not permitted \end{datadesc}
 \begin{datadesc}{ENOENT} No such file or directory \end{datadesc}
 \begin{datadesc}{ESRCH} No such process \end{datadesc}
index 507953d6e080dc3afe7e4493d2b05a778bc2ab4b..28f68c55d6d37f10380890cf4e0cba671b97d270 100644 (file)
@@ -2,21 +2,25 @@
 \label{module-errno}
 \stmodindex{errno}
 
-\setindexsubitem{(in module errno)}
 
 This module makes available standard errno system symbols.
 The value of each symbol is the corresponding integer value.
 The names and descriptions are borrowed from \file{linux/include/errno.h},
-which should be pretty all-inclusive.  Of the following list, symbols
-that are not used on the current platform are not defined by the
-module.
+which should be pretty all-inclusive.
 
-The module also defines the dictionary variable \code{errorcode} which
-maps numeric error codes back to their symbol names, so that e.g.
-\samp{errno.errorcode[errno.EPERM] == 'EPERM'}.  To translate a
-numeric error code to an error message, use \function{os.strerror()}.
+\begin{datadesc}{errorcode}
+  Dictionary providing a mapping from the errno value to the string
+  name in the underlying system.  For instance,
+  \code{errno.errorcode[errno.EPERM]} maps to \code{'EPERM'}.
+\end{datadesc}
+
+To translate a numeric error code to an error message, use
+\function{os.strerror()}.
+
+Of the following list, symbols that are not used on the current
+platform are not defined by the module.  Symbols available can
+include:
 
-Symbols available can include:
 \begin{datadesc}{EPERM} Operation not permitted \end{datadesc}
 \begin{datadesc}{ENOENT} No such file or directory \end{datadesc}
 \begin{datadesc}{ESRCH} No such process \end{datadesc}