From: Guido van Rossum <guido@python.org>
Date: Tue, 18 Nov 1997 15:27:51 +0000 (+0000)
Subject: Added doc for errorcode dictionary.
X-Git-Tag: v1.5b1~96
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=5de64883d8c28b0f294bc3ff5ef024d0da4aca86;p=python

Added doc for errorcode dictionary.
---

diff --git a/Doc/lib/liberrno.tex b/Doc/lib/liberrno.tex
index 9d7e52db89..2c45266783 100644
--- a/Doc/lib/liberrno.tex
+++ b/Doc/lib/liberrno.tex
@@ -5,11 +5,16 @@
 
 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 linux/include/errno.h,
+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.
 
+The module also defines the dictionary variable \code{errorcode} which
+maps numeric error codes back to their symbol names, so that e.g.
+\code{errno.errorcode[errno.EPERM] == 'EPERM'}.  To translate a
+numeric error code to an error message, use \code{os.strerror()}.
+
 Symbols available can include:
 \begin{datadesc}{EPERM} Operation not permitted \end{datadesc}
 \begin{datadesc}{ENOENT} No such file or directory \end{datadesc}
diff --git a/Doc/liberrno.tex b/Doc/liberrno.tex
index 9d7e52db89..2c45266783 100644
--- a/Doc/liberrno.tex
+++ b/Doc/liberrno.tex
@@ -5,11 +5,16 @@
 
 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 linux/include/errno.h,
+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.
 
+The module also defines the dictionary variable \code{errorcode} which
+maps numeric error codes back to their symbol names, so that e.g.
+\code{errno.errorcode[errno.EPERM] == 'EPERM'}.  To translate a
+numeric error code to an error message, use \code{os.strerror()}.
+
 Symbols available can include:
 \begin{datadesc}{EPERM} Operation not permitted \end{datadesc}
 \begin{datadesc}{ENOENT} No such file or directory \end{datadesc}