← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/graph.py

(spiv) Add docstrings to AbstractSearch and AbstractSearchResult. (Andrew
 Bennetts)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/graph.py
1537
1537
 
1538
1538
 
1539
1539
class AbstractSearchResult(object):
 
1540
    """The result of a search, describing a set of keys.
 
1541
    
 
1542
    Search results are typically used as the 'fetch_spec' parameter when
 
1543
    fetching revisions.
 
1544
 
 
1545
    :seealso: AbstractSearch
 
1546
    """
1540
1547
 
1541
1548
    def get_recipe(self):
1542
1549
        """Return a recipe that can be used to replay this search.
1575
1582
 
1576
1583
 
1577
1584
class AbstractSearch(object):
 
1585
    """A search that can be executed, producing a search result.
 
1586
 
 
1587
    :seealso: AbstractSearchResult
 
1588
    """
1578
1589
 
1579
1590
    def execute(self):
1580
1591
        """Construct a network-ready search result from this search description.