Commits

Ronald Oussoren committed 7928d3b

Some small documentation tweaks

  • Participants
  • Parent commits b566314

Comments (0)

Files changed (44)

pyobjc-core/Doc/blocks.rst

-===========================
-PyObjC support for "Blocks"
+PyObjC support for "blocks"
 ===========================
 
 Introduction
 -------------------
 
 The current implementation of blocks doesn't allow for full introspection, which means
-that PyObjC must be taught about the signatures of blocks. This section how that
-is done, but note that you only have to do this for your own code that defines methods 
-that have block arguments or return values. The PyObjC wrappers for the various frameworks
-already contain the required metadata. 
+that PyObjC must be taught about the signatures of blocks. 
 
-FIXME: The last two sentences aren't very clear.
+.. todo::
 
-This metadata is an extension to the "bridgesupport" format as defined by Apple.
-
-If an argument or return value is a block the metadata should contain an "block_pointer"
-attribute, with a value of "true". The element then has subelements describing the 
-signature of block (excluding the implicit block parameter). 
-
-As an example:
-
-.. sourcecode:: xml
-
-   <arg index="0" block_pointer="true">
-      <retval type="v" />
-      <arg type="@" />
-      <arg type="B" />
-   </arg>
-
-This metadata describes an argument that is a block of type ``(void(^)(id,BOOL)``.
+   Refer to the metadata documentation (which doesn't really exist at the moment)

pyobjc-core/Doc/fsref-fsspec.rst

         NOTE: This method is only available when ``Carbon`` support is
         enabled in the Python build.
     
-    NOTE: ``Carbon.File.FSSpec`` instances can be used as the argument
-    of functions that have an ``FSSpec`` structure as one of their
-    arguments.
+    .. note:: 
+
+       ``Carbon.File.FSSpec`` instances can be used as the argument
+       of functions that have an ``FSSpec`` structure as one of their
+       arguments.
+
+    .. note::
+
+       "FSSpec" is a deprecated type in Apple's APIs. The type is not 
+       availble for 64-bit code, and shouldn't be used for new development.

pyobjc-core/Doc/protocols.rst

 conformance to formal protocols.  However, all formal protocols in Cocoa
 are also described using ``objc.informal_protocol`` objects.
 
-XXX: is this necessary? we could also use the same strategy as for informal
-protocols, and drop the informal_protocol wrappers for formal protocols.
+.. todo::
+
+   Is this necessary? we could also use the same strategy as for informal
+   protocols, and drop the informal_protocol wrappers for formal protocols.
 
 In python 2.x declaring conformance to a formal protocol is done by using 
 the formal protocol as a mix-in, and by implementing its methods:
 		def unlock(self):
 			pass
 
-XXX: Change this example when the pyobjc_classMethods hack is no longer necessary.
-
 The class now formally implements the ``NSLocking`` protocol, this can be
 verified using the Objective-C introspection methods:
 
 This is useful for API's that require (and check) the implementation of formal
 protocols.
 
-XXX: might also be useful for Distributed Objects, create an example
+.. todo::
+
+   This might also be useful for Distributed Objects and XPC, create examples

pyobjc-framework-Accounts/Doc/api-notes-Accounts.txt

-API notes for Accounts
-======================
+API notes: Accounts framework
+=============================
 
 The entire "Accounts" framework on MacOSX 10.8 (or later) is available from Python.
 

pyobjc-framework-AddressBook/Doc/api-notes-AddressBook.txt

-API notes for AddressBook
-=========================
+API notes: AddressBook framework
+================================
 
 Plugin API
 ----------

pyobjc-framework-AppleScriptKit/Doc/api-notes-AppleScriptKit.txt

-API Notes for the AppleScriptKit framework
-==========================================
+API Notes: AppleScriptKit framework
+===================================
 
 The AppleScriptKit framework is wrapped completely by PyObjC.

pyobjc-framework-Automator/Doc/api-notes-Automator.txt

-API Notes for the Automator framework
-=====================================
+API Notes: Automator framework
+==============================
 
 The Automator framework is wrapped completely by PyObjC.

pyobjc-framework-CFNetwork/Doc/api-notes-CFNetwork.txt

-=====================================
-API Notes for the framework CFNetwork
-=====================================
+API Notes: CFNetwork framework
+==============================
 
 * ``CFNetworkExecuteProxyAutoConfigurationScript`` and ``CFNetworkExecuteProxyAutoConfigurationURL``
 

pyobjc-framework-CalendarStore/Doc/api-notes-CalenderStore.txt

-API Notes for the CalendarStore framework
-=========================================
+API Notes: CalendarStore framework
+==================================
 
 The CalendarStore framework is completely wrapped by PyObjC.

pyobjc-framework-Cocoa/Doc/api-notes-AppKit.txt

-==================================
-API Notes for the AppKit framework
-==================================
+API Notes: AppKit framework
+===========================
 
 ``NSColorSpace``
 ----------------

pyobjc-framework-Cocoa/Doc/api-notes-CoreFoundation.txt

-============================
-API Notes for CoreFoundation
-============================
+API Notes: CoreFoundation framework
+===================================
 
 Introduction
 ------------

pyobjc-framework-Cocoa/Doc/api-notes-Foudation.txt

-API Notes for the Foundation framework
-======================================
+API Notes: Foundation framework
+===============================
 
 Introduction
 ------------

pyobjc-framework-Cocoa/Doc/api-notes-Foundation.txt

-============================
-API Notes for Foundation
-============================
+API Notes: Foundation framework
+===============================
 
 Introduction
 ------------

pyobjc-framework-Cocoa/Doc/api-notes-kvo.txt

-=================================
-API Notes for Key-Value Observing
-=================================
+Key-Value Observing and Python
+==============================
 
 Key-Value Coding and Key-Value Observing are supported by PyObjC. Key-Value
 Observing is only supported for Cocoa objects though, because it is technically 

pyobjc-framework-Collaboration/Doc/api-notes-Collaboration.txt

-API Notes for the Collaboration framework
-=========================================
+API Notes: Collaboration framework
+==================================
 
 The Collaboration framework wrappers for PyObjC are complete.

pyobjc-framework-CoreData/Doc/api-notes-CoreData.txt

-======================
-API Notes for CoreData
-======================
+API Notes: CoreData framework
+=============================
 
 * class ``NSManagedObject``
 

pyobjc-framework-CoreLocation/Doc/api-notes-CoreLocation.txt

-API Notes for the CoreLocation framework
-=========================================
+API Notes: CoreLocation framework
+=================================
 
 The entire CoreLocation framework is supported
 

pyobjc-framework-CoreText/Doc/api-notes-CoreText.txt

-======================
-API Notes for CoreText
-======================
+API Notes: CoreText framework
+=============================
 
 * ``CTFontCreateWithQuickdrawInstance``
 

pyobjc-framework-DictionaryServices/Doc/api-notes-DictionaryServices.txt

-API Notes for the DictionaryServices framework
-==============================================
+API Notes: DictionaryServices framework
+=======================================
 
 PyObjC provides complete wrappers for the DictionaryServices framework.

pyobjc-framework-EventKit/Doc/api-notes-EventKit.txt

-API notes for Accounts
-======================
+API notes: EventKit framework
+=============================
 
-The entire "Accounts" framework on MacOSX 10.8 (or later) is available from Python.
+The entire "EventKit" framework on MacOSX 10.8 (or later) is available from Python.
 
 .. note:: 
 
-   The Accounts framework is only available in 64-bit applications.
+   The EventKit framework is only available in 64-bit applications.

pyobjc-framework-FSEvents/Doc/api-notes.txt

-==========================
-API Notes for FSEvents API
-==========================
+API Notes: FSEvents framework
+=============================
 
 The FSEvents package contains wrappers for the FSEvents API's, which are
 part of Carbon and not a standalone framework.

pyobjc-framework-InputMethodKit/Doc/api-notes-InputMethodKit.txt

-API Notes for framework InputMethodKit
-======================================
+API Notes: InputMethodKit framework
+===================================
 
 All API's in the InputMethodKit are wrapped by PyObjC.

pyobjc-framework-InstallerPlugins/Doc/api-notes-InstallerPlugins.txt

-API Notes for the InstallerPlugins framework
-============================================
+API Notes: InstallerPlugins framework
+=====================================
 
 All API's in the InstallerPlugins framework are wrapped by PyObjC.

pyobjc-framework-InstantMessage/Doc/api-notes-InstantMessage.txt

-API Notes for the InstantMessage framework
-==========================================
+API Notes: InstantMessage framework
+===================================
 
 All API's in the InstantMessage framework are wrapped by PyObjC.

pyobjc-framework-InterfaceBuilderKit/Doc/api-notes-InterfaceBuilderKit.txt

-API Notes for the InterfaceBuilderKit framework
-===============================================
+API Notes: InterfaceBuilderKit framework
+========================================
 
 All API's in this framework have been wrapped by PyObjC. 
 
-NOTE: This framework is only available when you have Xcode 3.0 or later
-installed, and furthermore the framework can only be used for writing plugins
-and not as part of standalone applications.
+This framework is only available when you have Xcode 3.x 
+installed, and furthermore the framework can only be used for 
+writing plugins and not as part of standalone applications.
+
+.. note:: 
+
+   This package will not work with Xcode 4, which is why
+   the package won't install automaticly on Mac OS X 10.8.
+

pyobjc-framework-LatentSemanticMapping/Doc/api-notes-LatentSemanticMapping.txt

-API Notes for framework LatentSemanticMapping
-=============================================
+API Notes: LatentSemanticMapping framework
+==========================================
 
 All functions in this framework are mapped, however the unittests
 for this framework wrapper cause crashes in the Python interpreter.

pyobjc-framework-LaunchServices/Doc/api-notes-LaunchServices.txt

-======================================
-API Notes for framework LaunchServices
-======================================
+API Notes: LaunchServices framework
+===================================
 
 This file documents where functionality in the LaunchServices wrappers does
 not match the behaviour that is described in Apple's documentation for

pyobjc-framework-Message/Doc/api-notes-Message.txt

-API Notes for the Message framework
-===================================
+API Notes: Message framework
+============================
 
 The PyObjC bindings for the Message framework are complete.
 

pyobjc-framework-OpenDirectory/Doc/api-notes-OpenDirectory.txt

-API Notes for the OpenDirectory and CFOpenDirectory frameworks
-==============================================================
+API Notes: OpenDirectory and CFOpenDirectory frameworks
+=======================================================
 
 Both the OpenDirectory framework and the embedded CFOpenDirectory framework are fully wrapped
 and can be used as described in the generic PyObjC documentation.

pyobjc-framework-PreferencePanes/Doc/api-notes-PreferencePanes.txt

-API Notes for the PreferencePanes framework
-===========================================
+API Notes: PreferencePanes framework
+====================================
 
 The PyObjC bindings for the PreferencePanes framework is complete.

pyobjc-framework-PubSub/Doc/api-notes-PubSub.txt

-API Notes for the PubSub framework
-==================================
+API Notes: PubSub framework
+===========================
 
 The PyObjC bindings for the PubSub framework are complete.

pyobjc-framework-QTKit/Doc/api-notes-QTKit.txt

-=================================
-API Notes for the QTKit framework
-=================================
+API Notes: QTKit framework
+==========================
 
 * Functions ``QTMakeTimeWithTimeRecord`` and ``QTGetTimeRecord`` are not 
   supported.

pyobjc-framework-Quartz/Doc/api-notes-CoreGraphics.txt

-API Notes for the CoreGraphics framework
-========================================
+API Notes: CoreGraphics framework
+=================================
 
 * ``CGColorSpaceCreateWithPlatformColorSpace``,
   ``CGColorSpaceCreateWithPlatformColorSpace``.

pyobjc-framework-Quartz/Doc/api-notes-Quartz.txt

+API Notes: Quartz frameworks
+============================
+
+Introduction
+------------
+
+This document describes special considerations for the PyObjC based Quartz
+bindings.
+
+Quartz vs. CoreGraphics
+-----------------------
+
+The PyObjC bindings for the Quartz related frameworks, including CoreGraphics
+and QuartzComposer are in the Python package "Quartz". When you use the
+system version of Python there's also a package named "CoreGraphics".  This
+is Apple's closed-source binding of CoreGraphics, which is not a direct
+mapping of the Quartz API's but includes some convenience APIs that are not 
+present in the C API. 
+
+The PyObjC bindings for Quartz are not compatible with the CoreGraphics 
+Python package by Apple.
+
+Importing
+---------
+
+The prefered way to import from packages in these bindings is::
+
+   from Quartz import *
+
+It is also possible to import directly from subwrappers (such
+as ``Quartz.CoreGraphics``), but it better to import from the toplevel
+to ensure you'll get all relevant definitions.
+
+
+
+Callbacks
+---------
+
+The ``userinfo`` for ``CGDataConsumerCreate``, ``CGDataProviderCreate``,
+``CGDataProviderCreateDirect``, ``CGDataProviderCreateDirectAccess``,
+``CGDataProviderCreateSequential``, ``CGDataProviderCreateWithData``,
+``CGDisplayRegisterReconfigurationCallback``, 
+``CGDisplayRemoveReconfigurationCallback``, 
+``CGFunctionCreate``, ``CGRegisterScreenRefreshCallback``, 
+``CGReleaseScreenRefreshRects``, ``CGScreenRegisterMoveCallback``,
+``CGScreenUnregisterMoveCallback``, ``CGUnregisterScreenRefreshCallback``,
+``CGPDFDictionaryApplyFunction``, ``CGPathApply``, ``CGPatternCreate``,
+``CGEventTapCreate``, ``CGEventTapCreateForPSN``, ``CGPDFOperatorTableSetCallback`` and ``CGPSConverterCreate``  can be any Python object.
+
+The function arguments for these functions can be any Python callable, 
+including bound methods. Functions mentioned earlier that have a struct with
+callback functions take in tuple with those callbacks in Python.
+
+``CGEventTapCreate`` and ``CGEventTapCreateForPSN`` leak some memory when they
+are called. This is needed to avoid memory management problems. It is therefore
+advisable not to call these functions, are at least call them a small number
+of times.
+
+``CGPatternCreate``: the callback argument is a single function: the ``drawPattern`` callback.
+
+``CGDataProviderCreateWithData``: the release callback can be ``None``. If it is not ``None`` it 
+must be a function with 1 argument: the ``info`` object.
+
+``CGPDFOperatorTableSetCallback`` is not supported at the moment.
+
+
+
+``CGColorSpaceCreateWithPlatformColorSpace``
+--------------------------------------------
+
+This function is not supported because the lowlevel "CMProfileRef" type is
+not wrappped by PyObjC.
+
+``kCGDirectMainDisplay``
+------------------------
+
+This value isn't actually a constant and can therefore not be wrapped by
+PyObjC. Use ``CGMainDisplayID()`` instead.
+
+``CGWindowListCreate``, ``CGWindowListCreateDescriptionFromArray``, ``CGWindowListCreateImageFromArray``
+--------------------------------------------------------------------------------------------------------
+
+
+
+This function is documented to return a "CFArray of CGWindowID". This specific type cannot be represented by
+PyObjC, therefore the (manually wrapped) function returns a tuple of CGWindowID values instead.
+
+For the same reason ``CGWindowListCreateDescriptionFromArray``, ``CGWindowListCreateImageFromArray`` are
+manually wrapped and take a tuple of WindowID values as an argument.
+
+``CGBitmapCreate``
+------------------
+
+The easiest way to use this function is to pass ``None`` as the buffer argument, that way Quartz will create the
+buffer for you. If you do want direct access to the buffer you'll have to create a writable buffer, for example
+like so::
+
+    bytes = array.array('B', (0 for i in xrange(100*80*4)))
+    ctx = CGBitmapContextCreate(bytes, 100, 80, 8, 400, CGColorSpaceCreateDeviceRGB(), kCGImageAlphaPremultipliedLast)
+
+This creates a context for a 100 pixels by 80 pixels image with a RGBA colorspace.
+
+Note that there limitations on the kinds of context's you can create, see the Apple documentation about supported
+pixel formats for the details on that.
+
+``CGColorSpaceGetColorTable``
+-----------------------------
+
+This function has an output buffer of indetermined size. You cannot pass ``None`` as the value of that buffer but have
+to explicitly specify a writable output buffer (such an ``array.array`` or the right type and size).
+
+Low-level PDF support
+---------------------
+
+Low-level PDF support in the CoreGraphics framework (such as the ``PDFArrayRef``
+type) are barely supported by PyObjC and these API's are currently not covered 
+by PyObjC's testsuite.
+
+Adding support for these API's is on the todo-list, but adding proper support
+requires work because the ``PDFArrayRef`` type (and simular types) is not
+a CoreFoundation based type.
+
+``CGPSConverter``
+------------------
+
+The API's related to CGPSConverter are not supported at the moment.
+
+
+``CIContext``
+-------------
+
+* ``-render:toBitmap:rowBytes:bounds:format:colorSpace``
+
+  You must pass a writable buffer of the right size to this method (such as 
+  a properly sized instance of ``array.array``.
+
+``CVPixelBufferCreate``
+-----------------------
+
+This function requires a manual wrapper and is not supported yet.
+
+``CVPixelBufferCreateWithBytes``
+--------------------------------
+
+This function requires a manual wrapper and is not supported yet.
+
+``CVPixelBufferCreateWithPlanarBytes``
+--------------------------------------
+
+This function requires a manual wrapper and is not supported yet.
+
+``CVFillExtendedPixelsCallBack``
+--------------------------------
+
+Pixel format attributes of this type are not supported.
+

pyobjc-framework-Quartz/Doc/api-notes.txt

-=======================================
-API Notes for the Quartz bindings
-=======================================
-
-Introduction
-------------
-
-This document describes special considerations for the PyObjC based Quartz
-bindings.
-
-Quartz vs. CoreGraphics
------------------------
-
-The PyObjC bindings for the Quartz related frameworks, including CoreGraphics
-and QuartzComposer are in the Python package "Quartz". When you use the
-system version of Python there's also a package named "CoreGraphics".  This
-is Apple's closed-source binding of CoreGraphics, which is not a direct
-mapping of the Quartz API's but includes some convenience APIs that are not 
-present in the C API. 
-
-The PyObjC bindings for Quartz are not compatible with the CoreGraphics 
-Python package by Apple.
-
-Importing
----------
-
-The prefered way to import from packages in these bindings is::
-
-   from Quartz import *
-
-It is also possible to import directly from subwrappers (such
-as ``Quartz.CoreGraphics``), but it better to import from the toplevel
-to ensure you'll get all relevant definitions.
-
-
-
-Callbacks
----------
-
-The ``userinfo`` for ``CGDataConsumerCreate``, ``CGDataProviderCreate``,
-``CGDataProviderCreateDirect``, ``CGDataProviderCreateDirectAccess``,
-``CGDataProviderCreateSequential``, ``CGDataProviderCreateWithData``,
-``CGDisplayRegisterReconfigurationCallback``, 
-``CGDisplayRemoveReconfigurationCallback``, 
-``CGFunctionCreate``, ``CGRegisterScreenRefreshCallback``, 
-``CGReleaseScreenRefreshRects``, ``CGScreenRegisterMoveCallback``,
-``CGScreenUnregisterMoveCallback``, ``CGUnregisterScreenRefreshCallback``,
-``CGPDFDictionaryApplyFunction``, ``CGPathApply``, ``CGPatternCreate``,
-``CGEventTapCreate``, ``CGEventTapCreateForPSN``, ``CGPDFOperatorTableSetCallback`` and ``CGPSConverterCreate``  can be any Python object.
-
-The function arguments for these functions can be any Python callable, 
-including bound methods. Functions mentioned earlier that have a struct with
-callback functions take in tuple with those callbacks in Python.
-
-``CGEventTapCreate`` and ``CGEventTapCreateForPSN`` leak some memory when they
-are called. This is needed to avoid memory management problems. It is therefore
-advisable not to call these functions, are at least call them a small number
-of times.
-
-``CGPatternCreate``: the callback argument is a single function: the ``drawPattern`` callback.
-
-``CGDataProviderCreateWithData``: the release callback can be ``None``. If it is not ``None`` it 
-must be a function with 1 argument: the ``info`` object.
-
-``CGPDFOperatorTableSetCallback`` is not supported at the moment.
-
-
-
-``CGColorSpaceCreateWithPlatformColorSpace``
---------------------------------------------
-
-This function is not supported because the lowlevel "CMProfileRef" type is
-not wrappped by PyObjC.
-
-``kCGDirectMainDisplay``
-------------------------
-
-This value isn't actually a constant and can therefore not be wrapped by
-PyObjC. Use ``CGMainDisplayID()`` instead.
-
-``CGWindowListCreate``, ``CGWindowListCreateDescriptionFromArray``, ``CGWindowListCreateImageFromArray``
---------------------------------------------------------------------------------------------------------
-
-
-
-This function is documented to return a "CFArray of CGWindowID". This specific type cannot be represented by
-PyObjC, therefore the (manually wrapped) function returns a tuple of CGWindowID values instead.
-
-For the same reason ``CGWindowListCreateDescriptionFromArray``, ``CGWindowListCreateImageFromArray`` are
-manually wrapped and take a tuple of WindowID values as an argument.
-
-``CGBitmapCreate``
-------------------
-
-The easiest way to use this function is to pass ``None`` as the buffer argument, that way Quartz will create the
-buffer for you. If you do want direct access to the buffer you'll have to create a writable buffer, for example
-like so::
-
-    bytes = array.array('B', (0 for i in xrange(100*80*4)))
-    ctx = CGBitmapContextCreate(bytes, 100, 80, 8, 400, CGColorSpaceCreateDeviceRGB(), kCGImageAlphaPremultipliedLast)
-
-This creates a context for a 100 pixels by 80 pixels image with a RGBA colorspace.
-
-Note that there limitations on the kinds of context's you can create, see the Apple documentation about supported
-pixel formats for the details on that.
-
-``CGColorSpaceGetColorTable``
------------------------------
-
-This function has an output buffer of indetermined size. You cannot pass ``None`` as the value of that buffer but have
-to explicitly specify a writable output buffer (such an ``array.array`` or the right type and size).
-
-Low-level PDF support
----------------------
-
-Low-level PDF support in the CoreGraphics framework (such as the ``PDFArrayRef``
-type) are barely supported by PyObjC and these API's are currently not covered 
-by PyObjC's testsuite.
-
-Adding support for these API's is on the todo-list, but adding proper support
-requires work because the ``PDFArrayRef`` type (and simular types) is not
-a CoreFoundation based type.
-
-``CGPSConverter``
-------------------
-
-The API's related to CGPSConverter are not supported at the moment.
-
-
-``CIContext``
--------------
-
-* ``-render:toBitmap:rowBytes:bounds:format:colorSpace``
-
-  You must pass a writable buffer of the right size to this method (such as 
-  a properly sized instance of ``array.array``.
-
-``CVPixelBufferCreate``
------------------------
-
-This function requires a manual wrapper and is not supported yet.
-
-``CVPixelBufferCreateWithBytes``
---------------------------------
-
-This function requires a manual wrapper and is not supported yet.
-
-``CVPixelBufferCreateWithPlanarBytes``
---------------------------------------
-
-This function requires a manual wrapper and is not supported yet.
-
-``CVFillExtendedPixelsCallBack``
---------------------------------
-
-Pixel format attributes of this type are not supported.
-

pyobjc-framework-ScreenSaver/Doc/api-notes-ScreenSaver.txt

-API Notes for the ScreenSaver framework
-=======================================
+API Notes: ScreenSaver framework
+================================
 
 The PyObjC bindings for the ScreenSaver framework are complete.

pyobjc-framework-ScriptingBridge/Doc/api-notes-ScriptingBridge.txt

-API Notes for the ScriptingBridge framework
-===========================================
+API Notes: ScriptingBridge framework
+====================================
 
 The PyObjC bindings for the ScriptingBridge framework are
 complete.

pyobjc-framework-SearchKit/Doc/api-notes-SearchKit.txt

-API Notes for the SearchKit framework
--------------------------------------
+API Notes: SearchKit framework
+==============================
 
 SKIndexClose
 ............

pyobjc-framework-Social/Doc/api-notes-Social.txt

-API notes for Social
-======================
+API notes: Social framework
+===========================
 
 The entire "Social" framework on MacOSX 10.8 (or later) is available from Python.

pyobjc-framework-SyncServices/Doc/api-notes-SyncServices.txt

-API Notes for the SyncServices framework
-========================================
+API Notes: SyncServices framework
+=================================
 
 PyObjC's bindings for the SyncServices framework are complete.

pyobjc-framework-SystemConfiguration/Doc/api-notes-SystemConfiguration.txt

-API Notes for the SystemConfiguration framework
-===============================================
+API Notes: SystemConfiguration framework
+========================================
 
 callbacks
 ---------

pyobjc-framework-WebKit/Doc/api-notes-JavaScriptCore.txt

-API Notes for framework JavaScript
-==================================
+API Notes: JavaScriptCore framework
+===================================
 
 This framework is provided as is, the wrapping is
 not tested at all at the moment and due to it's low-level

pyobjc-framework-WebKit/Doc/api-notes-WebKit.txt

-API Notes for framework WebKit
-==============================
+API Notes: WebKit framework
+===========================
 
 * Carbon integration functions are not supported.
 

pyobjc-framework-XgridFoundation/Doc/api-notes-XgridFoundation.txt

-API Notes for the XgridFoundation framework
-===========================================
+API Notes: XgridFoundation framework
+====================================
 
 PyObjC's bindings for the XgridFoundation framework are complete.
 
 .. note:: 
 
-   The XgridFoundation framework is not present in OSX 10.8 or later.
+   The XgridFoundation framework is not present in OSX 10.8 or later,
+   which means the XgridFoundation package will raise ImportError when
+   you try to use it on this release of OSX.