#2538: Python HTML documentation not necessary for help('module_name') feature
------------------------+---------------------------------------------------
Reporter: brightside | Owner: [email protected]
Type: defect | Status: new
Priority: normal | Milestone: 6.3
Component: BOOK | Version: SVN
Severity: normal | Resolution:
Keywords: |
------------------------+---------------------------------------------------
Comment (by [EMAIL PROTECTED]):
Thanks for the report.
a. Html documentation can be generated by using pydoc also
b. yes specific help about a module could be read by using docstrings and
the html downloaded documentation is not strictly required.
Though, to print help about a statement e.g, help('print') or
help('pass'), it still requires the documentation to be available and to
set the PYTHONDOCS variable.
So, yes, its better to leave out the sentence "In order to use the help
('module_name') feature of the python interpreter, you must download (or
create) the optional HTML documentation and install it."
But the rest of the instructions about the documentation should stay and
in my opinion to enhance it even more by adding information of how to use
effectively the help system.
I am inviting the operator of this ticket to add additional information to
this section.
--
Ticket URL: <http://wiki.linuxfromscratch.org/blfs/ticket/2538#comment:2>
BLFS Trac <http://wiki.linuxfromscratch.org/blfs>
Beyond Linux From Scratch
--
http://linuxfromscratch.org/mailman/listinfo/blfs-book
FAQ: http://www.linuxfromscratch.org/blfs/faq.html
Unsubscribe: See the above information page
