Rev 5649: (spiv) Add docstrings to AbstractSearch and AbstractSearchResult. (Andrew in file:///home/pqm/archives/thelove/bzr/%2Btrunk/

[Canonical.com Patch Queue Manager]

At file:///home/pqm/archives/thelove/bzr/%2Btrunk/

------------------------------------------------------------
revno: 5649 [merge]
revision-id: pqm at pqm.ubuntu.com-20110207063138-sq3gnzlz57p7thbr
parent: pqm at pqm.ubuntu.com-20110207053045-28d18h2ks7950g1h
parent: andrew.bennetts at canonical.com-20110207053716-ox7n3oej66hk80fb
committer: Canonical.com Patch Queue Manager <pqm at pqm.ubuntu.com>
branch nick: +trunk
timestamp: Mon 2011-02-07 06:31:38 +0000
message:
  (spiv) Add docstrings to AbstractSearch and AbstractSearchResult. (Andrew
   Bennetts)
modified:
  bzrlib/graph.py                graph_walker.py-20070525030359-y852guab65d4wtn0-1
=== modified file 'bzrlib/graph.py'
--- a/bzrlib/graph.py	2011-02-07 04:14:29 +0000
+++ b/bzrlib/graph.py	2011-02-07 05:37:16 +0000
@@ -1537,6 +1537,13 @@
 
 
 class AbstractSearchResult(object):
+    """The result of a search, describing a set of keys.
+    
+    Search results are typically used as the 'fetch_spec' parameter when
+    fetching revisions.
+
+    :seealso: AbstractSearch
+    """
 
     def get_recipe(self):
         """Return a recipe that can be used to replay this search.
@@ -1575,6 +1582,10 @@
 
 
 class AbstractSearch(object):
+    """A search that can be executed, producing a search result.
+
+    :seealso: AbstractSearchResult
+    """
 
     def execute(self):
         """Construct a network-ready search result from this search description.