summaryrefslogtreecommitdiff
path: root/Lib/pydoc.py
Commit message (Collapse)AuthorAgeFilesLines
* Merged revisions 83392,83426 via svnmerge fromGeorg Brandl2010-08-011-4/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | svn+ssh://pythondev@svn.python.org/python/branches/release27-maint ................ r83392 | georg.brandl | 2010-08-01 10:22:05 +0200 (So, 01 Aug 2010) | 1 line #8471: reset _SpoofOut.buf to an empty string when truncating; if Unicode had been output previously, it had been coerced to a Unicode string, potentially making subsequent prints behave differently or raise UnicodeErrors. ................ r83426 | georg.brandl | 2010-08-01 21:06:51 +0200 (So, 01 Aug 2010) | 27 lines Merged revisions 83370,83372-83374,83384 via svnmerge from svn+ssh://pythondev@svn.python.org/python/branches/py3k ........ r83370 | georg.brandl | 2010-07-31 23:51:48 +0200 (Sa, 31 Jul 2010) | 5 lines #8198: the Helper class should not save the stdin and stdout objects at import time, rather by default use the current streams like the other APIs that output help. ........ r83372 | georg.brandl | 2010-08-01 00:05:54 +0200 (So, 01 Aug 2010) | 1 line #4007: remove *.a and *.so.X.Y files in "make clean". ........ r83373 | georg.brandl | 2010-08-01 00:11:11 +0200 (So, 01 Aug 2010) | 1 line #5147: revert accidental indentation of header constant for MozillaCookieJar. ........ r83374 | georg.brandl | 2010-08-01 00:32:52 +0200 (So, 01 Aug 2010) | 1 line #5146: handle UID THREAD command correctly. ........ r83384 | georg.brandl | 2010-08-01 08:32:55 +0200 (So, 01 Aug 2010) | 1 line Build properties using lambdas. This makes test_pyclbr pass again, because it does not think that input and output are methods anymore. ........ ................
* Merged revisions 79543 via svnmerge fromBrian Curtin2010-04-011-1/+1
| | | | | | | | | | svn+ssh://pythondev@svn.python.org/python/trunk ........ r79543 | brian.curtin | 2010-03-31 23:02:00 -0500 (Wed, 31 Mar 2010) | 2 lines Fix a test_pydoc failure on Neal Norwitz's buildbot. ........
* Merged revisions 79529 via svnmerge fromBrian Curtin2010-03-311-1/+1
| | | | svn+ssh://pythondev@svn.python.org/python/trunk
* Merged revisions 79518 via svnmerge fromBrian Curtin2010-03-311-1/+2
| | | | | | | | | | svn+ssh://pythondev@svn.python.org/python/trunk ........ r79518 | brian.curtin | 2010-03-30 22:10:21 -0500 (Tue, 30 Mar 2010) | 2 lines Fix #8225. xml.etree was displaying an incorrect link when viewed in help. ........
* Merged revisions 78207 via svnmerge fromEzio Melotti2010-02-161-3/+1
| | | | | | | | | | svn+ssh://pythondev@svn.python.org/python/trunk ........ r78207 | ezio.melotti | 2010-02-17 01:26:09 +0200 (Wed, 17 Feb 2010) | 1 line #7930: fix stripid ........
* Merged revisions 76312 via svnmerge fromNick Coghlan2009-11-151-5/+7
| | | | | | | | | | svn+ssh://pythondev@svn.python.org/python/trunk ........ r76312 | nick.coghlan | 2009-11-16 08:36:47 +1000 (Mon, 16 Nov 2009) | 1 line Issue #7328: don't corrupt sys.path when running pydoc with the -m switch ........
* Merged revisions 73529 via svnmerge fromR. David Murray2009-06-231-3/+4
| | | | | | | | | | | | svn+ssh://pythondev@svn.python.org/python/trunk ........ r73529 | r.david.murray | 2009-06-23 14:02:46 -0400 (Tue, 23 Jun 2009) | 4 lines Fix issue 5230 by having pydoc's safeimport check to see if the import error was thrown from itself in order to decide if the module can't be found. Thanks to Lucas Prado Melo for collaborating on the fix and tests. ........
* Merged revisions 72966 via svnmerge fromR. David Murray2009-05-271-0/+1
| | | | | | | | | | | svn+ssh://pythondev@svn.python.org/python/trunk ........ r72966 | r.david.murray | 2009-05-27 16:07:21 -0400 (Wed, 27 May 2009) | 4 lines fix issue #6121 by stripping spaces from the argument in the 'help' function. ........
* Merged revisions 71443 via svnmerge fromMatthias Klose2009-04-101-1/+1
| | | | | | | | | | svn+ssh://pythondev@svn.python.org/python/trunk ........ r71443 | georg.brandl | 2009-04-10 10:20:23 +0200 (Fr, 10 Apr 2009) | 1 line #5698: Fix casing of !DOCTYPE to conform to W3C specs. ........
* Merged revisions ↵Georg Brandl2009-01-011-2/+55
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 67952-67953,67955,67957-67958,67960-67961,67963,67965,67967,67970-67971,67973,67982,67988,67990,67995,68014,68016,68030,68057,68061,68112,68115-68118,68120-68121,68123-68128 via svnmerge from svn+ssh://pythondev@svn.python.org/python/trunk ........ r67952 | georg.brandl | 2008-12-27 18:42:40 +0100 (Sat, 27 Dec 2008) | 2 lines #4752: actually use custom handler in example. ........ r67953 | georg.brandl | 2008-12-27 19:20:04 +0100 (Sat, 27 Dec 2008) | 3 lines Patch #4739 by David Laban: add symbols to pydoc help topics, so that ``help('@')`` works as expected. ........ r67955 | georg.brandl | 2008-12-27 19:27:53 +0100 (Sat, 27 Dec 2008) | 3 lines Follow-up to r67746 in order to restore backwards-compatibility for those who (monkey-)patch TextWrapper.wordsep_re with a custom RE. ........ r67957 | georg.brandl | 2008-12-27 19:49:19 +0100 (Sat, 27 Dec 2008) | 2 lines #4754: improve winsound documentation. ........ r67958 | georg.brandl | 2008-12-27 20:02:59 +0100 (Sat, 27 Dec 2008) | 2 lines #4682: 'b' is actually unsigned char. ........ r67960 | georg.brandl | 2008-12-27 20:04:44 +0100 (Sat, 27 Dec 2008) | 2 lines #4695: fix backslashery. ........ r67961 | georg.brandl | 2008-12-27 20:06:04 +0100 (Sat, 27 Dec 2008) | 2 lines Use :samp: role. ........ r67963 | georg.brandl | 2008-12-27 20:11:15 +0100 (Sat, 27 Dec 2008) | 2 lines #4671: document that pydoc imports modules. ........ r67965 | antoine.pitrou | 2008-12-27 21:34:52 +0100 (Sat, 27 Dec 2008) | 3 lines Issue #4677: add two list comprehension tests to pybench. ........ r67967 | benjamin.peterson | 2008-12-27 23:18:58 +0100 (Sat, 27 Dec 2008) | 1 line fix markup ........ r67970 | alexandre.vassalotti | 2008-12-28 02:52:58 +0100 (Sun, 28 Dec 2008) | 2 lines Fix name mangling of PyUnicode_ClearFreeList. ........ r67971 | alexandre.vassalotti | 2008-12-28 03:10:35 +0100 (Sun, 28 Dec 2008) | 2 lines Sort UCS-2/UCS-4 name mangling list. ........ r67973 | alexandre.vassalotti | 2008-12-28 03:58:22 +0100 (Sun, 28 Dec 2008) | 2 lines Document Py_VaBuildValue. ........ r67982 | benjamin.peterson | 2008-12-28 16:37:31 +0100 (Sun, 28 Dec 2008) | 1 line fix WORD_BIGEDIAN declaration in Universal builds; fixes #4060 and #4728 ........ r67988 | ronald.oussoren | 2008-12-28 20:40:56 +0100 (Sun, 28 Dec 2008) | 1 line Issue4064: architecture string for universal builds on OSX ........ r67990 | ronald.oussoren | 2008-12-28 20:50:40 +0100 (Sun, 28 Dec 2008) | 3 lines Update the fix for issue4064 to deal correctly with all three variants of universal builds that are presented by the configure script. ........ r67995 | benjamin.peterson | 2008-12-28 22:16:07 +0100 (Sun, 28 Dec 2008) | 1 line #4763 PyErr_ExceptionMatches won't blow up with NULL arguments ........ r68014 | benjamin.peterson | 2008-12-29 18:47:42 +0100 (Mon, 29 Dec 2008) | 1 line #4764 set IOError.filename when trying to open a directory on POSIX platforms ........ r68016 | benjamin.peterson | 2008-12-29 18:56:58 +0100 (Mon, 29 Dec 2008) | 1 line #4764 in io.open, set IOError.filename when trying to open a directory on POSIX platforms ........ r68030 | benjamin.peterson | 2008-12-29 22:38:14 +0100 (Mon, 29 Dec 2008) | 1 line fix French ........ r68057 | vinay.sajip | 2008-12-30 08:01:25 +0100 (Tue, 30 Dec 2008) | 1 line Minor documentation change relating to NullHandler. ........ r68061 | georg.brandl | 2008-12-30 11:15:49 +0100 (Tue, 30 Dec 2008) | 2 lines #4778: attributes can't be called. ........ r68112 | benjamin.peterson | 2009-01-01 00:48:39 +0100 (Thu, 01 Jan 2009) | 1 line #4795 inspect.isgeneratorfunction() should return False instead of None ........ r68115 | benjamin.peterson | 2009-01-01 05:04:41 +0100 (Thu, 01 Jan 2009) | 1 line simplfy code ........ r68116 | georg.brandl | 2009-01-01 12:46:51 +0100 (Thu, 01 Jan 2009) | 2 lines #4100: note that element children are not necessarily present on "start" events. ........ r68117 | georg.brandl | 2009-01-01 12:53:55 +0100 (Thu, 01 Jan 2009) | 2 lines #4156: make clear that "protocol" is to be replaced with the protocol name. ........ r68118 | georg.brandl | 2009-01-01 13:00:19 +0100 (Thu, 01 Jan 2009) | 2 lines #4185: clarify escape behavior of replacement strings. ........ r68120 | georg.brandl | 2009-01-01 13:15:31 +0100 (Thu, 01 Jan 2009) | 4 lines #4228: Pack negative values the same way as 2.4 in struct's L format. ........ r68121 | georg.brandl | 2009-01-01 13:43:33 +0100 (Thu, 01 Jan 2009) | 2 lines Point to types module in new module deprecation notice. ........ r68123 | georg.brandl | 2009-01-01 13:52:29 +0100 (Thu, 01 Jan 2009) | 2 lines #4784: ... on three counts ... ........ r68124 | georg.brandl | 2009-01-01 13:53:19 +0100 (Thu, 01 Jan 2009) | 2 lines #4782: Fix markup error that hid load() and loads(). ........ r68125 | georg.brandl | 2009-01-01 14:02:09 +0100 (Thu, 01 Jan 2009) | 2 lines #4776: add data_files and package_dir arguments. ........ r68126 | georg.brandl | 2009-01-01 14:05:13 +0100 (Thu, 01 Jan 2009) | 2 lines Handlers are in the `logging.handlers` module. ........ r68127 | georg.brandl | 2009-01-01 14:14:49 +0100 (Thu, 01 Jan 2009) | 2 lines #4767: Use correct submodules for all MIME classes. ........ r68128 | antoine.pitrou | 2009-01-01 15:11:22 +0100 (Thu, 01 Jan 2009) | 3 lines Issue #3680: Reference cycles created through a dict, set or deque iterator did not get collected. ........
* #3707: fix inf. recursion in pydoc topic search. Rev'd by Antoine.Georg Brandl2008-08-301-3/+3
|
* Silence SyntaxWarning and DeprecationWarning in pydoc triggered by tupleBrett Cannon2008-08-031-10/+15
| | | | unpacking in parameter lists and using callable(). Found through -3.
* #3045: fix pydoc behavior for TEMP path with spaces.Georg Brandl2008-07-161-2/+2
|
* Issue 3190: pydoc now hides module __package__ attributesNick Coghlan2008-07-021-2/+3
|
* Generate pydoc's topic help from the reST docs via Sphinx'Georg Brandl2008-06-011-136/+125
| | | | new text writer.
* Revert the renaming of repr to reprlib.Brett Cannon2008-05-231-1/+1
|
* Tkinter rename reversal: remove tkinter package, adapt imports and docs.Georg Brandl2008-05-201-16/+16
|
* Tkinter rename, step 2: fix imports and add stub modules.Georg Brandl2008-05-161-16/+16
|
* Changed references to the reprlib module to use its new name.Alexandre Vassalotti2008-05-161-1/+1
|
* #2133: fix HTML color spec.Georg Brandl2008-02-171-1/+1
|
* Update PEP URL.Andrew M. Kuchling2008-02-051-1/+1
| | | | | | | (This code is duplicated between pydoc and DocXMLRPCServer; maybe it should be refactored as a GHOP project.) 2.5.2 backport candidate.
* Remove effectless expression statement.Georg Brandl2008-01-271-1/+0
|
* #1715: include sub-extension modules in pydoc text output.Georg Brandl2008-01-211-1/+13
|
* Adapt pydoc to new doc URLs.Georg Brandl2008-01-211-7/+6
|
* Check in the patch proposed by Ben Hayden (benjhayden) for issueKa-Ping Yee2008-01-131-3/+5
| | | | | | | | | #1550: help('modules') broken by several 3rd party libraries. Tested with Python build: trunk:54235:59936M -- the reported error occurs with Django installed (or with any __init__.py present on the path that raises an exception), and such errors indeed go away when this change is applied.
* Patch #1194449: correctly detect unbound methods in pydoc.Georg Brandl2007-03-131-2/+2
|
* Patch #1530482: add pydoc.render_doc() which returns the documentationGeorg Brandl2007-03-131-22/+26
| | | | for a thing instead of paging it to stdout, which pydoc.doc() does.
* Patch #1542681: add entries for "with", "as" and "CONTEXTMANAGERS" toGeorg Brandl2007-03-131-0/+3
| | | | pydoc's help keywords.
* Bug #1628895: some better tries to find HTML documentation in pydoc.Georg Brandl2007-03-021-7/+12
|
* Handle old-style instances more gracefully (display documentation onKa-Ping Yee2007-01-141-6/+13
| | | | the relevant class instead of documentation on <type 'instance'>).
* [Patch #1600491 from Jim Jewett] Describe how to build help files on WindowsAndrew M. Kuchling2006-12-191-0/+3
|
* Patch #1520294: Support for getset and member descriptors in types.py,Barry Warsaw2006-07-271-1/+21
| | | | | | | | | | | | | | | | | | | | | | | | | | | | inspect.py, and pydoc.py. Specifically, this allows for querying the type of an object against these built-in C types and more importantly, for getting their docstrings printed in the interactive interpreter's help() function. This patch includes a new built-in module called _types which provides definitions of getset and member descriptors for use by the types.py module. These types are exposed as types.GetSetDescriptorType and types.MemberDescriptorType. Query functions are provided as inspect.isgetsetdescriptor() and inspect.ismemberdescriptor(). The implementations of these are robust enough to work with Python implementations other than CPython, which may not have these fundamental types. The patch also includes documentation and test suite updates. I commit these changes now under these guiding principles: 1. Silence is assent. The release manager has not said "no", and of the few people that cared enough to respond to the thread, the worst vote was "0". 2. It's easier to ask for forgiveness than permission. 3. It's so dang easy to revert stuff in svn, that you could view this as a forcing function. :) Windows build patches will follow.
* Second phase of refactoring for runpy, pkgutil, pydoc, and setuptoolsPhillip J. Eby2006-04-181-109/+73
| | | | | | | | | | | | | | | | | | | | to share common PEP 302 support code, as described here: http://mail.python.org/pipermail/python-dev/2006-April/063724.html pydoc now supports PEP 302 importers, by way of utility functions in pkgutil, such as 'walk_packages()'. It will properly document modules that are in zip files, and is backward compatible to Python 2.3 (setuptools installs for Python <2.5 will bundle it so pydoc doesn't break when used with eggs.) What has not changed is that pydoc command line options do not support zip paths or other importer paths, and the webserver index does not support sys.meta_path. Those are probably okay as limitations. Tasks remaining: write docs and Misc/NEWS for pkgutil/pydoc changes, and update setuptools to use pkgutil wherever possible, then add it to the stdlib.
* Fix pydoc.synopsis() so that it doesn't error out with an unreadableGeorg Brandl2006-03-081-1/+5
| | | | module.
* The names of lambda functions are now properly displayed in pydoc.Georg Brandl2006-02-171-1/+1
|
* Fix SF bug #417833 (pydoc HTTP reload failure) by removing fromKa-Ping Yee2005-11-051-13/+17
| | | | | sys.modules all submodules of a the given module/package path when trying to reload a module.
* Accept patch to resolve SF bug #651124.Ka-Ping Yee2005-11-051-2/+2
|
* fix typos, mostly in commentsFred Drake2005-10-281-1/+1
|
* Merge ast-branch to headJeremy Hylton2005-10-201-0/+1
| | | | | | | | | | This change implements a new bytecode compiler, based on a transformation of the parse tree to an abstract syntax defined in Parser/Python.asdl. The compiler implementation is not complete, but it is in stable enough shape to run the entire test suite excepting two disabled tests.
* bug [ 729103 ] Cannot retrieve name of super objectGeorg Brandl2005-10-011-3/+3
|
* That was one too much.Georg Brandl2005-07-221-1/+1
|
* Fix all wrong instances of "it's".Georg Brandl2005-07-221-1/+1
|
* Use getdoc(object) instead of object.__doc__ to fix indentation problems.Ka-Ping Yee2005-02-191-2/+10
| | | | | | | | | | | 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.)
* Replace list of constants with tuples of constants.Raymond Hettinger2005-02-061-9/+9
|
* Patch #936774: unify the display of data descriptors, including slots,Johannes Gijsbers2005-01-081-37/+27
| | | | | | | | | | | | | | | 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!
* SF patch #1094007: Remove witty comment in pydoc.pyRaymond Hettinger2005-01-011-2/+1
| | | | (Removed at Ping's request.)
* Back out rev 1.96; see #1009389.Martin v. Löwis2004-11-141-1/+1
|
* Patch #1061931 / bug #971872: factor out part of spillproperties, soJohannes Gijsbers2004-11-071-30/+55
| | | | | properties are also documented if help(Class.<property>) is called instead of help(Class).
* Patch #934356: if a module defines __all__, believe that rather than usingJohannes Gijsbers2004-08-301-4/+12
| | | | heuristics for filtering out imported names.
* Patch #997284: Allow pydoc to work with XP Themes (.manifest file)Martin v. Löwis2004-08-221-2/+10
| | | | Will backport to 2.3.