Skip to content

Commit

Permalink
improved the documentation to make it more specific to the methods th…
Browse files Browse the repository at this point in the history
…ey are describing.
  • Loading branch information
ddehghan committed Mar 18, 2012
1 parent 0507823 commit cb6739e
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions mrjob/job.py
Expand Up @@ -369,10 +369,10 @@ def steps(self):
re-defined. For example::
def steps(self):
return [self.mr(mapper=self.transform_input,
reducer=self.consolidate_1),
self.mr(reducer_init=self.log_mapper_init,
reducer=self.consolidate_2)]
return [self.mr(mapper=self.my_mapper1,
reducer=self.my_reducer1),
self.mr(mapper=self.my_mapper2,
reducer=self.my_reducer2)]
:return: a list of steps constructed with :py:meth:`mr`
"""
Expand All @@ -389,7 +389,7 @@ def mr(cls, mapper=None, reducer=None, _mapper_final=None, **kwargs):
"""Define a step (mapper, reducer, and/or any combination of
mapper_init, reducer_final, etc.) for your job.
Used by :py:meth:`steps`. (Don't re-define this, just call it!)
Used by :py:meth:`steps`. (Don't re-define mr method, just call it!)
Accepts the following keyword arguments. For convenience, you may
specify *mapper* and *reducer* as positional arguments as well.
Expand Down

0 comments on commit cb6739e

Please sign in to comment.