Commits

Ronald Oussoren committed 8fbfbdd

Small documentation tweaks

* Fix typo

* Change 'NOTE:' to a sphinx ..note::

* Mention that FSRef is also deprecated (as of OSX 10.8)

Note: the deprecation notice is a 'note::' paragraph and not a 'deprecated::' because
the latter uses the first argument word as a version number and I cannot specify
an OSX release there.

Comments (0)

Files changed (1)

pyobjc-core/Doc/fsref-fsspec.rst

     This type represents an opaque ``FSRef`` structure.
 
     New instances are created using the ``from_pathname`` method:
-    .. sourcecode:: pycon
+
+    .. sourcecode:: python
     
         >>> ref = objc.FSRef.from_pathname("/Libray")
         >>> isinstance(ref, objc.FSRef)
         NOTE: This method is only available when ``Carbon`` support is
         enabled in the Python build.
 
-    NOTE: ``Carbon.File.FSRef`` instances can be used as the argument
-    of functions that have an ``FSRef`` structure as one of their
-    arguments.
+    .. note:: ``Carbon.File.FSRef`` instances can be used as the argument
+       of functions that have an ``FSRef`` structure as one of their
+       arguments.
+
+
+    .. note::
+       All API's using the FSRef type are deprecated by Apple as of Mac OS X 10.8,
+       for most of those APIs there are alternate APIs that use URL objects
+       (:c:type:`NSURL` or :c:type:`CFURL`).
 
 .. class:: objc.FSSpec
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.