updated docstring

git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk/docutils/docutils@1904 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

1 files changed, 12 insertions, 5 deletions

diff --git a/__init__.py b/__init__.py
index fe1c4c18e..7921ab022 100644
--- a/__init__.py
+++ b/__init__.py
@@ -124,11 +124,18 @@ class TransformSpec:
     """Transforms required by this class.  Override in subclasses."""
     
     unknown_reference_resolvers = ()
-    """List of functions to try to resolve unknown references. Called when
-    FinalCheckVisitor is unable to find a correct target. The list should
-    contain functions which will try to resolve unknown references. Each 
-    function can have a default_priority attribute which will effect the order 
-    the unknown_reference_resolvers are run. Override in subclass"""
+    """List of functions to try to resolve unknown references.  Called when
+    FinalCheckVisitor is unable to find a correct target.  The list should
+    contain functions which will try to resolve unknown references, with the
+    following signature::
+
+        def reference_resolver(node):
+            '''Returns boolean: true if resolved, false if not.'''
+
+    Each function must have a "priority" attribute which will affect the order
+    the unknown_reference_resolvers are run.
+
+    Override in subclasses."""
 
 
 class Component(SettingsSpec, TransformSpec):