Commits

Zero Piraeus committed f24ec68

Fix the <README>.

Comments (0)

Files changed (1)

 :Author: Zero Piraeus
 :Contact: z@etiol.net
 
-`ook` is a simple library to assist with monkeypatching Python methods and
-functions on a per-Python-version basis. It provides one decorator, `patch`,
-which conditionally patches callables depending on which version of Python
-is running.
+**ook** is a simple library to assist with monkeypatching Python methods and
+functions on a per-Python-version basis. It provides one decorator, ``patch``,
+which conditionally patches callables depending on which version of Python is
+running.
 
 .. contents:: Contents
 
 Example
 -------
 
-This one's used in `ook`'s test suite::
+This one's used in **ook**'s test suite::
 
     import itertools
     from ook import patch
 Usage
 -----
 
-`patch` accepts an arbitrary number of version arguments, in a variety of
+``patch`` accepts an arbitrary number of version arguments, in a variety of
 formats::
 
     @patch(some.module.or.class, 2.5, "2.6.8", (2, 7, 3), 3):
         """Do something."""
         pass
 
-... as well as `min` and `max` keyword arguments::
+... as well as ``min`` and ``max`` keyword arguments::
 
     @patch(some.module.or.class, min="2.5.4", max=2.7):
     def method_or_function(signature):
 
 .. Note:: If you specify both keyword and non-keyword version arguments, the
    patch will only take effect if both the explicitly specified versions and
-   the implied ranges are satisfied).
+   the implied ranges are satisfied.
 
-With no arguments other than the module or class to be patched, `patch` applies
-the patch regardless of Python version::
+With no arguments other than the module or class to be patched, ``patch``
+applies the patch regardless of Python version::
 
     @patch(some.module.or.class):
     def method_or_function(signature):
 Credits / Copyright
 -------------------
 
-`ook` was (cough) "inspired" by Guido van Rossum's `monkeypatch_method`[1]_
-recipe. Thanks, Guido :-)
+**ook** was (cough) "inspired" by Guido van Rossum's monkeypatch_ recipe.
+Thanks, Guido :-)
 
 It's released under the GNU General Public License (version 3 or later), a copy
-of which is included with this distribution in the file "COPYING".
+of which is included with this distribution in the file **COPYING**.
 
 
-.. [1] http://mail.python.org/pipermail/python-dev/2008-January/076194.html
+.. _monkeypatch: http://mail.python.org/pipermail/python-dev/2008-January/076194.html