[Pythonmac-SIG] Fixing the documentation...

Bill Janssen janssen at parc.com
Wed Apr 19 02:23:10 CEST 2006


Just looking at the docs, I'm trying to figure out what's good and
what's bad.

1) We should no longer point people to Jack's site, we point them to
   the python.org Mac download page instead.

2) references to PythonIDE and PackageManager should go.

3) What about the following:

        2. MacPython Modules
        2.1 macpath -- MacOS path manipulation functions
        2.2 macfs -- Various file system services
        2.2.1 FSSpec Objects
        2.2.2 Alias Objects
        2.2.3 FInfo Objects
        2.3 ic -- Access to Internet Config
        2.3.1 IC Objects
        2.4 MacOS -- Access to Mac OS interpreter features
        2.5 macostools -- Convenience routines for file manipulation
        2.6 findertools -- The finder's Apple Events interface
        2.7 EasyDialogs -- Basic Macintosh dialogs
        2.7.1 ProgressBar Objects
        2.8 FrameWork -- Interactive application framework
        2.8.1 Application Objects
        2.8.2 Window Objects
        2.8.3 ControlsWindow Object
        2.8.4 ScrolledWindow Object
        2.8.5 DialogWindow Objects
        2.9 autoGIL -- Global Interpreter Lock handling in event loops
        3. MacPython OSA Modules
        3.1 gensuitemodule -- Generate OSA stub packages
        3.2 aetools -- OSA client support
        3.3 aepack -- Conversion between Python variables and AppleEvent data containers
        3.4 aetypes -- AppleEvent objects
        3.5 MiniAEFrame -- Open Scripting Architecture server support
        3.5.1 AEServer Objects
        4. MacOS Toolbox Modules
        4.1 Carbon.AE -- Apple Events
        4.2 Carbon.AH -- Apple Help
        4.3 Carbon.App -- Appearance Manager
        4.4 Carbon.CF -- Core Foundation
        4.5 Carbon.CG -- Core Graphics
        4.6 Carbon.CarbonEvt -- Carbon Event Manager
        4.7 Carbon.Cm -- Component Manager
        4.8 Carbon.Ctl -- Control Manager
        4.9 Carbon.Dlg -- Dialog Manager
        4.10 Carbon.Evt -- Event Manager
        4.11 Carbon.Fm -- Font Manager
        4.12 Carbon.Folder -- Folder Manager
        4.13 Carbon.Help -- Help Manager
        4.14 Carbon.List -- List Manager
        4.15 Carbon.Menu -- Menu Manager
        4.16 Carbon.Mlte -- MultiLingual Text Editor
        4.17 Carbon.Qd -- QuickDraw
        4.18 Carbon.Qdoffs -- QuickDraw Offscreen
        4.19 Carbon.Qt -- QuickTime
        4.20 Carbon.Res -- Resource Manager and Handles
        4.21 Carbon.Scrap -- Scrap Manager
        4.22 Carbon.Snd -- Sound Manager
        4.23 Carbon.TE -- TextEdit
        4.24 Carbon.Win -- Window Manager
        4.25 ColorPicker -- Color selection dialog
        5. Undocumented Modules
        5.1 applesingle -- AppleSingle decoder
        5.2 buildtools -- Helper module for BuildApplet and Friends
        5.3 cfmfile -- Code Fragment Resource module
        5.4 icopen -- Internet Config replacement for open()
        5.5 macerrors -- Mac OS Errors
        5.6 macresource -- Locate script resources
        5.7 Nav -- NavServices calls
        5.8 PixMapWrapper -- Wrapper for PixMap objects
        5.9 videoreader -- Read QuickTime movies
        5.10 W -- Widgets built on FrameWork
        5.11 waste -- non-Apple TextEdit replacement

My inclination is to delete them all :-).  Except for ones where
someone pipes up and tells me it still works.  Let folks use the Wiki
to find modules.

4)  Should we document some of the newer stuff?  py2app comes to mind.

Bill


More information about the Pythonmac-SIG mailing list