]> granicus.if.org Git - python/commitdiff
Issue #8983: Corrected docstrings.
authorAlexander Belopolsky <alexander.belopolsky@gmail.com>
Mon, 16 Aug 2010 20:17:07 +0000 (20:17 +0000)
committerAlexander Belopolsky <alexander.belopolsky@gmail.com>
Mon, 16 Aug 2010 20:17:07 +0000 (20:17 +0000)
Lib/doctest.py
Lib/inspect.py
Modules/_threadmodule.c
Modules/pwdmodule.c
Objects/typeobject.c

index d1b96d4d08f63907a522fa7731da7f5d771e1747..0a0dafdfaefe6bad1474ff0f1a51d4ec233003f2 100644 (file)
@@ -1786,7 +1786,7 @@ def testmod(m=None, name=None, globs=None, verbose=None,
 
     Return (#failures, #tests).
 
-    See doctest.__doc__ for an overview.
+    See help(doctest) for an overview.
 
     Optional keyword arg "name" gives the name of the module; by default
     use m.__name__.
index 3bc220b851cf5d7577ae8de895dd409ea8f3b8d9..61c2502f05b44666c37da2515b55fbfe76f20550 100644 (file)
@@ -159,7 +159,7 @@ def isgeneratorfunction(object):
 
     Generator function objects provides same attributes as functions.
 
-    See isfunction.__doc__ for attributes listing."""
+    See help(isfunction) for attributes listing."""
     return bool((isfunction(object) or ismethod(object)) and
                 object.__code__.co_flags & CO_GENERATOR)
 
index 30379677dd09d398f0fa0ea46841b2a93c2e0ee3..a7fb017c6cfd831e87befe07c641b1561aa4ec5b 100644 (file)
@@ -1078,7 +1078,7 @@ PyDoc_STRVAR(allocate_doc,
 "allocate_lock() -> lock object\n\
 (allocate() is an obsolete synonym)\n\
 \n\
-Create a new lock object.  See LockType.__doc__ for information about locks.");
+Create a new lock object.  See help(LockType) for information about locks.");
 
 static PyObject *
 thread_get_ident(PyObject *self)
index b303f95f3158fbbf008b989c5fd41a4d9d31c243..4e6bd2facfc8e7ac34ea8f6766881d237489df05 100644 (file)
@@ -100,7 +100,7 @@ PyDoc_STRVAR(pwd_getpwuid__doc__,
 "getpwuid(uid) -> (pw_name,pw_passwd,pw_uid,\n\
                   pw_gid,pw_gecos,pw_dir,pw_shell)\n\
 Return the password database entry for the given numeric user ID.\n\
-See pwd.__doc__ for more on password database entries.");
+See help(pwd) for more on password database entries.");
 
 static PyObject *
 pwd_getpwuid(PyObject *self, PyObject *args)
@@ -121,7 +121,7 @@ PyDoc_STRVAR(pwd_getpwnam__doc__,
 "getpwnam(name) -> (pw_name,pw_passwd,pw_uid,\n\
                     pw_gid,pw_gecos,pw_dir,pw_shell)\n\
 Return the password database entry for the given user name.\n\
-See pwd.__doc__ for more on password database entries.");
+See help(pwd) for more on password database entries.");
 
 static PyObject *
 pwd_getpwnam(PyObject *self, PyObject *args)
@@ -152,7 +152,7 @@ PyDoc_STRVAR(pwd_getpwall__doc__,
 "getpwall() -> list_of_entries\n\
 Return a list of all available password database entries, \
 in arbitrary order.\n\
-See pwd.__doc__ for more on password database entries.");
+See help(pwd) for more on password database entries.");
 
 static PyObject *
 pwd_getpwall(PyObject *self)
index 7bb686421bf845c3836a0d207a139dcbab96dec1..1babcb605c3bd7b35440c7b2399b143b09127d4c 100644 (file)
@@ -2515,7 +2515,7 @@ static PyMethodDef type_methods[] = {
     {"__instancecheck__", type___instancecheck__, METH_O,
      PyDoc_STR("__instancecheck__() -> check if an object is an instance")},
     {"__subclasscheck__", type___subclasscheck__, METH_O,
-     PyDoc_STR("__subclasschck__ -> check if an class is a subclass")},
+     PyDoc_STR("__subclasscheck__() -> check if a class is a subclass")},
     {0}
 };
 
@@ -5521,7 +5521,7 @@ static slotdef slotdefs[] = {
            wrap_descr_delete, "descr.__delete__(obj)"),
     FLSLOT("__init__", tp_init, slot_tp_init, (wrapperfunc)wrap_init,
            "x.__init__(...) initializes x; "
-           "see x.__class__.__doc__ for signature",
+           "see help(type(x)) for signature",
            PyWrapperFlag_KEYWORDS),
     TPSLOT("__new__", tp_new, slot_tp_new, NULL, ""),
     TPSLOT("__del__", tp_del, slot_tp_del, NULL, ""),