Pydoc enhanced browsing patch

[ron3200, 2010-11-18 23:02:57]

http://codereview.appspot.com/3151042/diff/2001/Doc/library/pydoc.rst
File Doc/library/pydoc.rst (right):

http://codereview.appspot.com/3151042/diff/2001/Doc/library/pydoc.rst#newcode54
Doc/library/pydoc.rst:54: ``-p 1234`` will start a HTTP server on port 1234,
allowing you to browse
Resolve svn conflict.  Original version was corrected.

http://codereview.appspot.com/3151042/diff/2001/Doc/whatsnew/3.2.rst
File Doc/whatsnew/3.2.rst (right):

http://codereview.appspot.com/3151042/diff/2001/Doc/whatsnew/3.2.rst#newcode557
Doc/whatsnew/3.2.rst:557: as well as a new command line option to automatically
open a browser
command line -> command-line

http://codereview.appspot.com/3151042/diff/2001/Lib/pydoc.py
File Lib/pydoc.py (right):

http://codereview.appspot.com/3151042/diff/2001/Lib/pydoc.py#newcode1879
Lib/pydoc.py:1879: return
Remove extra return.

http://codereview.appspot.com/3151042/diff/2001/Lib/pydoc.py#newcode1889
Lib/pydoc.py:1889: return 'no documentation found for %s' % repr(topic), ''
The showtopic() method above, also uses repr(topic) in the case of errors. This
ensures there are quotes around the topic string, and gives a more meaningful
message if something other than a string gets passed in.

http://codereview.appspot.com/3151042/diff/2001/Lib/pydoc.py#newcode2343
Lib/pydoc.py:2343: #True
These lines are commented out to avoid opening the web browser when a doctest is
run on this module.  I can remove the #'s or add a note saying why the exist.

http://codereview.appspot.com/3151042/diff/2001/Lib/pydoc.py#newcode2368
Lib/pydoc.py:2368: import threading
These imports are only needed in the case the server is used.  Why import them
if all you need is help()?  If we ever move this server into it's own module, it
will make things easier to keep them here.  I will move them to the top of this
file, if someone really has a problem with them being here.

http://codereview.appspot.com/3151042/diff/2001/Lib/pydoc.py#newcode2380
Lib/pydoc.py:2380: content_type = 'text/html'
Add "charset" parameter.

http://codereview.appspot.com/3151042/diff/2001/Lib/pydoc.py#newcode2481
Lib/pydoc.py:2481: """ % sys.version
Shorten version info, and try to make it less cluttered.  Put buttons to left
(or right?) of 'Get' and 'Search' input fields.

http://codereview.appspot.com/3151042/diff/2001/Lib/pydoc.py#newcode2780
Lib/pydoc.py:2780: """ % (cmd, os.sep, cmd, cmd, cmd, cmd, cmd, os.sep))
Use keyword substitutions.

[ron3200, 2010-11-19 00:23:48]

http://codereview.appspot.com/3151042/diff/2001/Doc/library/pydoc.rst
File Doc/library/pydoc.rst (right):

http://codereview.appspot.com/3151042/diff/2001/Doc/library/pydoc.rst#newcode54
Doc/library/pydoc.rst:54: ``-p 1234`` will start a HTTP server on port 1234,
allowing you to browse
On 2010/11/18 23:02:57, ron3200 wrote:
> Resolve svn conflict.  Original version was corrected.

Done.

http://codereview.appspot.com/3151042/diff/2001/Doc/whatsnew/3.2.rst
File Doc/whatsnew/3.2.rst (right):

http://codereview.appspot.com/3151042/diff/2001/Doc/whatsnew/3.2.rst#newcode557
Doc/whatsnew/3.2.rst:557: as well as a new command line option to automatically
open a browser
On 2010/11/18 23:02:57, ron3200 wrote:
> command line -> command-line

Done.

http://codereview.appspot.com/3151042/diff/2001/Lib/pydoc.py
File Lib/pydoc.py (right):

http://codereview.appspot.com/3151042/diff/2001/Lib/pydoc.py#newcode1879
Lib/pydoc.py:1879: return
On 2010/11/18 23:02:57, ron3200 wrote:
> Remove extra return.

Done.

http://codereview.appspot.com/3151042/diff/2001/Lib/pydoc.py#newcode2380
Lib/pydoc.py:2380: content_type = 'text/html'
On 2010/11/18 23:02:57, ron3200 wrote:
> Add "charset" parameter.

Attempt at changeing 'text/html' to 'text/html; charset=UTF-8' resulted in an
error being sent to the browser.  Error: unknown content type text/html;
charset=UTF-8.

http://codereview.appspot.com/3151042/diff/2001/Lib/pydoc.py#newcode2650
Lib/pydoc.py:2650: fp = open(os.path.join(path_here, url))
The value of path_here is not set.  Fix or comment out 'text/css' portions.

http://codereview.appspot.com/3151042/diff/2001/Lib/pydoc.py#newcode2652
Lib/pydoc.py:2652: fp.close()
Use with statement here.

[ron3200, 2010-11-19 00:37:02]

http://codereview.appspot.com/3151042/diff/2001/Lib/pydoc.py
File Lib/pydoc.py (right):

http://codereview.appspot.com/3151042/diff/2001/Lib/pydoc.py#newcode2380
Lib/pydoc.py:2380: content_type = 'text/html'
On 2010/11/19 00:23:48, ron3200 wrote:
> On 2010/11/18 23:02:57, ron3200 wrote:
> > Add "charset" parameter.
> 
> Attempt at changeing 'text/html' to 'text/html; charset=UTF-8' resulted in an
> error being sent to the browser.  Error: unknown content type text/html;
> charset=UTF-8.

Worked with 'chrset', not 'charset'.

Done.

[ron3200, 2010-11-19 17:30:43]

http://codereview.appspot.com/3151042/diff/2001/Lib/pydoc.py
File Lib/pydoc.py (right):

http://codereview.appspot.com/3151042/diff/2001/Lib/pydoc.py#newcode2343
Lib/pydoc.py:2343: #True
On 2010/11/18 23:02:57, ron3200 wrote:
> These lines are commented out to avoid opening the web browser when a doctest
is
> run on this module.  I can remove the #'s or add a note saying why the exist. 


Added line explaining comments.

Done.

http://codereview.appspot.com/3151042/diff/2001/Lib/pydoc.py#newcode2481
Lib/pydoc.py:2481: """ % sys.version
On 2010/11/18 23:02:57, ron3200 wrote:
> Shorten version info, and try to make it less cluttered.  Put buttons to left
> (or right?) of 'Get' and 'Search' input fields.

Done.

http://codereview.appspot.com/3151042/diff/2001/Lib/pydoc.py#newcode2780
Lib/pydoc.py:2780: """ % (cmd, os.sep, cmd, cmd, cmd, cmd, cmd, os.sep))
On 2010/11/18 23:02:57, ron3200 wrote:
> Use keyword substitutions. 

Done.

[ron3200, 2010-11-19 21:10:27]

http://codereview.appspot.com/3151042/diff/2001/Lib/pydoc.py
File Lib/pydoc.py (right):

http://codereview.appspot.com/3151042/diff/2001/Lib/pydoc.py#newcode2538
Lib/pydoc.py:2538: f.close()
Use with statement here.

http://codereview.appspot.com/3151042/diff/2001/Lib/pydoc.py#newcode2650
Lib/pydoc.py:2650: fp = open(os.path.join(path_here, url))
On 2010/11/19 00:23:48, ron3200 wrote:
> The value of path_here is not set.  Fix or comment out 'text/css' portions.

Done.

http://codereview.appspot.com/3151042/diff/2001/Lib/pydoc.py#newcode2652
Lib/pydoc.py:2652: fp.close()
On 2010/11/19 00:23:48, ron3200 wrote:
> Use with statement here.

Done.

[ron3200, 2010-11-19 21:11:55]

http://codereview.appspot.com/3151042/diff/2001/Lib/pydoc.py
File Lib/pydoc.py (right):

http://codereview.appspot.com/3151042/diff/2001/Lib/pydoc.py#newcode2538
Lib/pydoc.py:2538: f.close()
On 2010/11/19 21:10:27, ron3200 wrote:
> Use with statement here.

Done.

[ron3200, 2010-11-21 06:48:24]

Almost done, I hope. ;-)

http://codereview.appspot.com/3151042/diff/18001/Lib/pydoc.py
File Lib/pydoc.py (right):

http://codereview.appspot.com/3151042/diff/18001/Lib/pydoc.py#newcode438
Lib/pydoc.py:438: </body></html>''' % (title, contents, css_path)
remove css_path left over from previous edit.

http://codereview.appspot.com/3151042/diff/18001/Lib/pydoc.py#newcode2335
Lib/pydoc.py:2335: >>> serverthread = pydoc._startserver(my_url_handler, port)
pydoc._startserver(  ->  pydoc._start_server(