[Python-bugs-list] [ python-Bugs-426740 ] pydoc: check bases for doc strings?
noreply@sourceforge.net
noreply@sourceforge.net
Mon, 28 May 2001 09:34:14 -0700
Bugs item #426740, was updated on 2001-05-23 13:18
You can respond by visiting:
http://sourceforge.net/tracker/?func=detail&atid=105470&aid=426740&group_id=5470
Category: Python Library
Group: Feature Request
Status: Open
Resolution: None
Priority: 2
Submitted By: Skip Montanaro (montanaro)
Assigned to: Ka-Ping Yee (ping)
Summary: pydoc: check bases for doc strings?
Initial Comment:
Given the following class hierarchy:
class A:
def foo(self):
"do the foo"
pass
class B(A):
def foo(self):
pass
class C(B):
def foo(self):
"do the foo in C"
pass
if you ask pydoc for help about A or C you will get the
corresponding doc string. If you ask for help about B,
however, you see no documentation. Would be kinda nice
if pydoc.help(B) displayed "do the foo" as the doc
string for B.foo.
----------------------------------------------------------------------
Comment By: Bastian Kleineidam (calvin)
Date: 2001-05-28 09:34
Message:
Logged In: YES
user_id=9205
No, please dont do this, IMO its the wrong way.
B.foo() is different from A.foo(), so it needs
a different doc string.
Just imagine I document A.foo() with "do the foo in A",
then your scheme is not working.
Bastian
----------------------------------------------------------------------
You can respond by visiting:
http://sourceforge.net/tracker/?func=detail&atid=105470&aid=426740&group_id=5470