From 549cb6ea030d257c6e037f8f55be1a7656396d15 Mon Sep 17 00:00:00 2001 From: Guido van Rossum Date: Tue, 11 Aug 1998 17:50:22 +0000 Subject: Added a module docstring (that's all this module needs). --- Modules/errnomodule.c | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/Modules/errnomodule.c b/Modules/errnomodule.c index 2b15d71f..8120075 100644 --- a/Modules/errnomodule.c +++ b/Modules/errnomodule.c @@ -80,11 +80,25 @@ _inscode(d, de, name, code) Py_XDECREF(v); } +static char errno__doc__ [] = +"This module makes available standard errno system symbols.\n\ +\n\ +The value of each symbol is the corresponding integer value,\n\ +e.g., on most systems, errno.ENOENT equals the integer 2.\n\ +\n\ +The dictionary errno.errorcode maps numeric codes to symbol names,\n\ +e.g., errno.errorcode[2] could be the string 'ENOENT'.\n\ +\n\ +Symbols that are not relevant to the underlying system are not defined.\n\ +\n\ +To map error codes to error messages, use the function os.strerror(),\n\ +e.g. os.strerror(2) could return 'No such file or directory'."; + void initerrno() { PyObject *m, *d, *de; - m = Py_InitModule("errno", errno_methods); + m = Py_InitModule3("errno", errno_methods, errno__doc__); d = PyModule_GetDict(m); de = PyDict_New(); if (de == NULL || PyDict_SetItemString(d,"errorcode",de)) -- cgit v0.12