Commits

Ronald Oussoren committed d71e77b

Some small documentation tweaks

Comments (0)

Files changed (11)

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

-API notes: AddressBook framework
+API Notes: AddressBook framework
 ================================
 
 API Notes

pyobjc-framework-Cocoa/Doc/AppCategories.txt

-=================================================
-API Description for ``PyObjCTools.AppCategories``
-=================================================
+====================================================
+API Description for :mod:`PyObjCTools.AppCategories`
+====================================================
+
+.. module:: PyObjCTools.AppCategories
+   :synopsis: Useful categories on classes from AppKit
+
 
 Introduction
 ------------
 
-The module ``PyObjCTools.AppCategories`` defines a number of categories on
-classes from the ``AppKit`` framework. These categories introduce
+The module :mod:`PyObjCTools.AppCategories` defines a number of categories on
+classes from the *AppKit* framework. These categories introduce
 new methods that aren't present in that framework.
 
 To use these new methods use the following code somewhere in your program:
 
 This module defines a method for ``NSGraphicsContext``:
 
-* ``savedGraphicsState``
+.. method:: NSGraphicsContext.savedGraphicsState
 
-  This is a Python context-manager for use with the ``with`` statement.
+   This is a Python context-manager for use with the ``with`` statement.
 
-  Usage:
+   Usage:
 
-    .. sourcecode:: python
+   .. sourcecode:: python
 
       with NSGraphicsContext.savedGraphicsState():
           pass
 
-  This is equivalent to:
+   This is equivalent to:
 
-    .. sourcecode:: python
+   .. sourcecode:: python
 
       NSGraphicsContext.saveGraphicsState()
       try:
 Context-manager for ``NSAnimationContext``
 ------------------------------------------
 
-Class ``NSAnimationContext`` can be used as the context for a ``with`` 
+Class :c:type:`NSAnimationContext` can be used as the context for a ``with`` 
 statement:
 
     .. sourcecode:: python

pyobjc-framework-Cocoa/Doc/FndCategories.txt

-=================================================
-API Description for ``PyObjCTools.FndCategories``
-=================================================
+====================================================
+API Description for :mod:`PyObjCTools.FndCategories`
+====================================================
+
+.. module:: PyObjCTools.FndCategories
+   :synopsis: Useful categories on classes from Foundation
+
 
 Introduction
 ------------
 
-The module ``PyObjCTools.FndCategories`` defines a number of categories on
-classes from the ``Foundation`` framework. These categories introduce
+The module :mod:`PyObjCTools.FndCategories` defines a number of categories on
+classes from the *Foundation* framework. These categories introduce
 new methods that aren't present in that framework.
 
 To use these new methods use the following code somewhere in your program::
        import PyObjCTools.FndCategories
 
 
-Additional methods on ``NSAffineTransform``
--------------------------------------------
+Additional methods on :class:`NSAffineTransform`
+-------------------------------------------------
 
-This module defines a number of new methods for ``NSAffineTransform``:
+.. class:: NSAffineTransform
 
-* ``rotateByDegrees_atPoint_(angle, point)``
+   .. method:: rotateByDegrees_atPoint_(angle, point)
 
-  This is simular to ``rotateByDegrees_`` but rotates around ``point`` instead
-  of the origin.
+      This is simular to ``rotateByDegrees_`` but rotates around ``point`` instead
+      of the origin.
 
-* ``rotateByRadians_atPoint_(angle, point)``
+   .. method:: rotateByRadians_atPoint_(angle, point)
 
-  This is simular to ``rotateByRadians_`` but rotates around ``point`` instead
-  of the origin.
+      This is simular to ``rotateByRadians_`` but rotates around ``point`` instead
+      of the origin.

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

 API Notes
 ---------
 
+API Extensions
+...............
+
+See :doc:`/api/module-PyObjCTools.AppCategories` for same extensions for
+the APIs from the AppKit framework.
+
 ``NSColorSpace``
 ................
 

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

 API Notes
 ---------
 
+API additions
+.............
+
+See :doc:`/api/module-PyObjCTools.FndCategories` for some API extensions
+for the Foundation framework.
+
 NSAppleEventDescriptor, NSAppleEventManager
 ...........................................
 

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

-API notes: EventKit framework
+API Notes: EventKit framework
 =============================
 
 API Notes

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

+API Notes: FSEvents framework
+=============================
+
+API Notes
+---------
+
+The FSEvents package contains wrappers for the FSEvents API's, which are
+part of Carbon and not a standalone framework.
+
+The FSEventsRef type is an opaque pointer, unlike what the name suggests this
+is not a CoreFounation based types. As a side-effect of that the programmer
+is responsibly for managing the retain-count of objects of this type.
+
+This means you have to call ``FSEventStreamRelease`` when you're done with
+a stream. You must not use the stream after that, it will then refer to an
+invalid stream.

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

-API Notes: FSEvents framework
-=============================
-
-API Notes
----------
-
-The FSEvents package contains wrappers for the FSEvents API's, which are
-part of Carbon and not a standalone framework.
-
-The FSEventsRef type is an opaque pointer, unlike what the name suggests this
-is not a CoreFounation based types. As a side-effect of that the programmer
-is responsibly for managing the retain-count of objects of this type.
-
-This means you have to call ``FSEventStreamRelease`` when you're done with
-a stream. You must not use the stream after that, it will then refer to an
-invalid stream.

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

 API Notes
 ---------
 
+* See :doc:`/api/coregraphics-context-managers` for some extensions
+  to the CoreGraphics API.
+
 * ``CGColorSpaceCreateWithPlatformColorSpace``,
   ``CGColorSpaceCreateWithPlatformColorSpace``.
 

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

 API Notes
 ---------
 
+API Extensions
+..............
+
+See :doc:`/api/coregraphics-context-managers` for some extensions to the API
+in the CoreGraphics framework.
+
 Callbacks
 .........
 

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

-API notes: Social framework
+API Notes: Social framework
 ===========================
 
 API Notes