Skip to content

Commit

Permalink
Update Analysis docstrings to refer to callables. Closes #198.
Browse files Browse the repository at this point in the history
  • Loading branch information
onyxfish committed Aug 29, 2015
1 parent ad70c77 commit 7eb5653
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions agate/analysis.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ class Analysis(object):
Implements a promise-like API so that Analyses can depend on one another.
If a parent analysis is invalidated then all it's children will be as well.
:param func: The analysis function. Must accept a `data` argument that
is the state inherited from ancestors analysis.
:param func: A callable that implements the analysis. Must accept a `data`
argument that is the state inherited from its ancestors analysis.
:param parent: The parent analysis of this one, if any.
:param cache_path: Where to stored the cache files for this analysis.
"""
Expand Down Expand Up @@ -111,8 +111,9 @@ def then(self, next_func):
Create a new analysis which will run after this one has completed with
access to the data it generated.
:param func: The analysis function. Must accept a `data` argument that
is the state inherited from ancestors analysis.
:param func: A callable that implements the analysis. Must accept a
`data` argument that is the state inherited from its ancestors
analysis.
"""
analysis = Analysis(next_func, parent=self, cache_path=self._cache_path)

Expand Down

0 comments on commit 7eb5653

Please sign in to comment.