From 9fa220986784bd9e4d63343ed0e22a2a8559ead7 Mon Sep 17 00:00:00 2001 From: Sam Thursfield Date: Fri, 4 Jul 2014 15:37:45 +0100 Subject: Rewrite SplitRules.partition() docstring to be clearer to me --- morphlib/artifactsplitrule.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'morphlib') diff --git a/morphlib/artifactsplitrule.py b/morphlib/artifactsplitrule.py index 16b0e81b..125f5b93 100644 --- a/morphlib/artifactsplitrule.py +++ b/morphlib/artifactsplitrule.py @@ -150,9 +150,10 @@ class SplitRules(collections.Iterable): def partition(self, iterable): '''Match many files or artifacts. - It's the common case to take a bunch of filenames and determine - which artifact each should go to, so rather than implement this - logic in multiple places, it's here as a convenience method. + This function takes an iterable of file names, and groups them + using the rules that have been added to this object. + + This is a convenience function that uses the match() method internally. ''' -- cgit v1.2.1