bba6acc714
Use getdoc(object) instead of object.__doc__ to fix indentation problems.
...
Thanks to Robert Dick <dickrp@ece.northwestern.edu> for reporting this bug
and submitting a patch.
Adjust doc(object) to display useful documentation for plain values (e.g.
help([]) now shows the methods on the list instead of just printing "[]").
(This change has been tested interactively, by generating docs for the
standard library, and by running the module documentation webserver.)
2005-02-19 22:58:26 +00:00
dbecd93b72
Replace list of constants with tuples of constants.
2005-02-06 06:57:08 +00:00
9ddb300598
Patch #936774 : unify the display of data descriptors, including slots,
...
properties, and custom descriptors.
* removed special handling of properties
* added special handling of data descriptors - All data descriptors are grouped
together in a section. For each item, the attribute name and doc string, if
present, is displayed.
* disabled display of __slots__ attribute - since slots are descriptors, they
are listed in the section described above
Thanks to John Belmonte for the patch!
2005-01-08 20:16:43 +00:00
ed2dbe3f33
SF patch #1094007 : Remove witty comment in pydoc.py
...
(Removed at Ping's request.)
2005-01-01 07:51:01 +00:00
6fe8f1928f
Back out rev 1.96; see #1009389 .
2004-11-14 10:21:04 +00:00
8de645a176
Patch #1061931 / bug #971872 : factor out part of spillproperties, so
...
properties are also documented if help(Class.<property>) is called
instead of help(Class).
2004-11-07 19:16:05 +00:00
4c11f6088a
Patch #934356 : if a module defines __all__, believe that rather than using
...
heuristics for filtering out imported names.
2004-08-30 14:13:04 +00:00
e09bd93685
Patch #997284 : Allow pydoc to work with XP Themes (.manifest file)
...
Will backport to 2.3.
2004-08-22 16:13:26 +00:00
ac37f3d001
Patch #1009389 : Make __credits__ a Unicode object.
2004-08-22 16:08:04 +00:00
e7691d36b7
Use readline/raw_input() in pydoc.Helper.interact if available and self.input
...
is sys.stdin. Based on a patch (#726204 ) by Dmitry Vasiliev and a comment from
Guido in an older patch (#549901 ).
2004-08-17 13:21:53 +00:00
84601f14a3
Change pydoc.stripid() be able to match against 64-bit addresses by having
...
regex match from 6 to 16 characters.
2004-06-19 01:22:48 +00:00
c6c1f478d9
pydoc.stripid() is now case-insensitive for its regex to support platforms that
...
have pointer addresses in uppercase.
Closes bug #934282 . Thanks Robin Becker.
2004-06-19 01:02:51 +00:00
a5616d2255
Respect a module's __all__ attribute. Closes #969938 .
2004-06-11 04:46:12 +00:00
f2134842b4
correct name error caught by Neal Norwitz with pychecker
2004-06-07 02:40:05 +00:00
756b3f3c15
* Move collections.deque() in from the sandbox
...
* Add unittests, newsitem, and whatsnew
* Apply to Queue.py mutex.py threading.py pydoc.py and shlex.py
* Docs are forthcoming
2004-01-29 06:37:52 +00:00
f9b08b8e60
Patch #785689 : Use basename in usage. Backported to 2.3.
2003-10-31 13:05:21 +00:00
6b59f5f3fd
Let library modules use the new keyword arguments for list.sort().
2003-10-16 05:53:16 +00:00
4997a69fe4
display link to module docs when it looks like the object module is a core
...
module
2003-09-10 16:47:51 +00:00
0fe8fce7e3
(HTML|Text)Repr.repr1: Guard against objects whos types have no __name__
...
attribute. Patch and bug report from Geoff Talvola. Closes patch #672855 .
2003-06-27 15:45:41 +00:00
b8c084e82c
Support keyword and topics help in cli(). Fixes #715782 .
2003-06-14 09:03:46 +00:00
28a4f0f965
Have pydoc try handling an object as "other" if the object does not act the way
...
it expects based on what inspect classifies it as.
Closes bug #729103 .
2003-06-11 23:38:55 +00:00
54f871e193
Fix SF bug #735694 , Pydoc.py fixes links
...
Modified the patch some. Fixed invalid link in UNICODE (to STRING).
Also updates some references.
2003-05-26 13:49:54 +00:00
e59e2bab8f
Patch #711902 : Cause pydoc to show data descriptor __doc__ strings.
2003-05-03 09:09:02 +00:00
742dde4ddd
SF patch #706338 , Fix a few broken links in pydoc by Greg Chapman
2003-03-30 20:31:34 +00:00
d9e213eeca
Hide private names beginning with _ (but don't hide __special__ names).
...
Clean up section headings; make the bars on the left less fat.
Adjust the display of properties slightly.
Don't show stuff inherited from the base 'object' type.
2003-03-28 16:35:51 +00:00
4f959d2c73
Fix SF patch #695581 , "returnself" -> "return self"
2003-03-01 15:22:41 +00:00
68468eba63
Get rid of many apply() calls.
2003-02-27 20:14:51 +00:00
97dede0202
Fix for SF 686380, from SF patch 686771 by Ping. (errors trying to
...
get help on os attributes)
2003-02-16 01:12:32 +00:00
f98159c376
Fix SF bug #642168 , help() fails for some builtin topics
...
Fix pydoc when doing help for: and, or, not, UNICODE.
Will backport.
2003-02-07 20:49:40 +00:00
550e4e5583
SF bug 666444: 'help' makes linefeed only under Win32.
...
Reverting one of those irritating "security fixes". fdopen() opens
files in binary mode. That makes pydoc skip the \r\n on Windows that's
need to make the output readable in the shell. Screw it.
2003-02-07 01:53:46 +00:00
5b26abb37a
Gracefully delay runtime error up to 1s. Add .willdispatch().
2002-12-28 09:23:09 +00:00
4f759d8504
Correct erroneous parenthesis placement in the delta from 1.63 to 1.64.
2002-11-02 02:02:46 +00:00
fb05c4e5bb
SF bug 630824: pydoc Helper keywords missing 'yield'
...
Wow, what a brittle subsystem! Fixed, maybe, provided Fred doesn't
shuffle the docs around.
Bugfix candidate.
2002-10-30 05:21:00 +00:00
fca3bb6a29
Explicitly use floor division
2002-10-21 04:44:11 +00:00
d404bee2e2
try executing 'less' in a parenthesized subshell - prevents systems like
...
Solaris from squawking if less isn't available. See
http://python.org/sf/612111 for details.
2002-09-26 21:44:57 +00:00
b2628b0f37
Added the standard MacOSX location for documentation inside a framework
...
to the list of places where pydoc looks for HTML documents.
2002-08-23 08:40:42 +00:00
45daeb093f
Extend stripid() to handle strings ending in more than one '>'.
...
Add resolve() to handle looking up objects and names (fix SF bug 586931).
Add a nicer error message when given a filename that doesn't exist.
2002-08-11 15:11:33 +00:00
3b0a3293c3
Massive changes from SF 589982 (tempfile.py rewrite, by Zack
...
Weinberg). This changes all uses of deprecated tempfile functions to
the recommended ones.
2002-08-09 16:38:32 +00:00
fce538c31e
Add a coding cookie, because of the møøse quote.
2002-08-06 17:29:38 +00:00
32200aeac6
Replaced obsolete stat module constants with equivalent attributes
2002-06-01 19:51:15 +00:00
54f0222547
SF 563203. Replaced 'has_key()' with 'in'.
2002-06-01 14:18:47 +00:00
5e355b244f
In both spilldata() functions, pretend that the docstring for
...
non-callable objects is always None. This makes for less confusing
output and fixes the problem reported in SF patch #550290 .
2002-05-21 20:56:15 +00:00
8ca162f417
Partial introduction of bools where appropriate.
2002-04-07 06:36:23 +00:00
bc0e910826
Convert a pile of obvious "yes/no" functions to return bool.
2002-04-04 22:55:58 +00:00
cddc1a0249
Quote href properly.
2002-03-24 23:11:21 +00:00
d69711cb1e
Remove unnecessary \b. It was causing the RE to miss the tailing
...
slash on strings like "http://www.python.org/ is good".
2002-03-24 23:02:07 +00:00
df708788b6
add repr_str as alias for repr_string in both HTMLRepr and TextRepr classes
...
- reflects the change in type("").__name__ between 2.1 and 2.2. The
__name__ field is used to find a method to call for particular types.
2002-03-07 22:58:02 +00:00
54e0eabc2d
OS/2 more program behaves like Win32 more
...
(see patch #514490 , by Stefan Schwarzer)
2002-03-03 03:12:30 +00:00
59ed448bc6
SF patch #474485 : pydoc generates some bad html, from Rich Salz.
2001-10-31 04:20:26 +00:00
8dd7adeb34
SF bug [ #472347 ] pydoc and properties.
...
The GUI-mode code to display properties blew up if the property functions
(get, set, etc) weren't simply methods (or functions).
"The problem" here is really that the generic document() method dispatches
to one of .doc{routine, class, module, other}(), but all of those require
a different(!) number of arguments. Thus document isn't general-purpose
at all: you have to know exactly what kind of thing is it you're going
to document first, in order to pass the correct number of arguments to
.document for it to pass on. As an expedient hack, just tacked "*ignored"
on to the end of the formal argument lists for the .docXXX routines so
that .document's caller doesn't have to know in advance which path
.document is going to take.
2001-10-18 19:56:17 +00:00
Ka-Ping Yee
Raymond Hettinger
Johannes Gijsbers
Martin v. Löwis
Brett Cannon
Skip Montanaro
Neal Norwitz
Guido van Rossum
Tim Peters
Jack Jansen
Neil Schemenauer
Andrew MacIntyre