summaryrefslogtreecommitdiff
path: root/morphlib
diff options
context:
space:
mode:
authorSam Thursfield <sam.thursfield@codethink.co.uk>2014-07-04 15:37:45 +0100
committerSam Thursfield <sam.thursfield@codethink.co.uk>2014-07-04 15:53:44 +0100
commit9fa220986784bd9e4d63343ed0e22a2a8559ead7 (patch)
treeef77c32410d9f2b6cdfd0e0388ed64330bbf6f64 /morphlib
parentb27d3f0d496b0358ab5c3bc2a8ecef5f863a635b (diff)
downloadmorph-9fa220986784bd9e4d63343ed0e22a2a8559ead7.tar.gz
Rewrite SplitRules.partition() docstring to be clearer to me
Diffstat (limited to 'morphlib')
-rw-r--r--morphlib/artifactsplitrule.py7
1 files changed, 4 insertions, 3 deletions
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.
'''