12.07.2015 Views

Is Python a

Is Python a

Is Python a

SHOW MORE
SHOW LESS
  • No tags were found...

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

help(docstrings.square)Help on function square in module docstrings:square(x)function documentationcan we have your liver then?>>> help(docstrings.employee)...more omitted...>>> help(docstrings)Help on module docstrings:NAMEdocstringsFILEc:\python22\docstrings.pyDESCRIPTIONModule documentationWords Go HereCLASSESemployee...more omitted...FUNCTIONSsquare(x)function documentationcan we have your liver then?DATA_ _file_ _ = 'C:\\PYTHON22\\docstrings.pyc'_ _name_ _ = 'docstrings'spam = 40PyDoc: HTML ReportsThe help function is nice for grabbing documentation when working interactively.For a more grandiose display, however, PyDoc also provides a GUI interface (asimple, but portable, <strong>Python</strong>/Tkinter script), and can render its report in HTML pageformat, viewable in any web browser. In this mode, PyDoc can run locally or as aremote server in client/server mode; reports contain automatically created hyperlinksthat allow you to click your way through the documentation of related components inyour application.To start PyDoc in this mode, you generally first launch the search engine GUI capturedin Figure 14-1. You can start this either by selecting the Module Docs item in<strong>Python</strong>’s Start button menu on Windows, or by launching the pydocgui.pyw script in<strong>Python</strong>’s Tools directory (running pydoc.py with a –g command-line argument works,<strong>Python</strong> Documentation Sources | 285

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!