Professional IronPython

using the Module documentation
The module documentation provides terse information about each of the modules provided in the 
Standard Library. However, the information you receive is normally enough to use the module. To 
start this feature, choose Start
➤➤➪➤➤
Programs
➤➤➪➤➤
Python 2.6
➤➤➪➤➤
Module Docs. You’ll see the pydoc dia-
log box shown in Figure 6-3. This dialog box already has a search term entered into it.
When you enter a search term and press Enter, Module 
Docs searches the documentation to locate all of the 
matching entries. To use a particular search result, high-
light its entry in the list and click Go To Selected. Your 
browser will open and show a search topic similar to the 
one shown in Figure 6-4.
You might want to do a little exploring, rather than enter 
a specific search term. In this case, click Open Browser 
on the pydoc dialog box to go to the top-level Module 
Docs page shown in Figure 6-5. Simply click the links to 
drill down to the search topic you want.
After you find all of the information you want, click 
Quit Serving on the pydoc dialog box. Module Docs will 
shut down. Because Module Docs runs on an internal Web server, you’ll want to shut Module Docs 
down when your search is complete to save processing cycles.
using the Python Manuals
The Python Manuals are a full-fledged compiled help module, which is the same kind of help 
you’ve been using in Windows for just about every other application you own. To access this 
FIguRE 6-3: 
Use Module Docs to discover
specifics about Python modules.
548592c06.indd 104
2/24/10 12:47:52 PM
www.finebook.ir

---

Using the Standard Library Features
 
❘
 
105
feature, choose Start
➤➤➪➤➤
Programs
➤➤➪➤➤
Python 2.6
➤➤➪➤➤
Python Manuals. You’ll see the Python 2.6.4 
Documentation window shown in Figure 6-6.
As you can see, the Python Manual relies on a standard help file. You can search it, look through 
the table of contents, click links, and do everything else you’d do with a standard help file.
FIguRE 6-4: 
Obtain specific help on the module for which you searched.
One potential issue with using the Python Manuals is that the help is Python-specific. This help file 
will contain information that won’t apply to IronPython in some cases because IronPython doesn’t 
precisely implement the full Python feature set. Consequently, you need to test any help you receive 
before you accept it as completely useful.