From 325e75114915abfbb09c07a57bef93fd53c4f759 Mon Sep 17 00:00:00 2001
From: Jeremy Fincher <jemfinch@users.sourceforge.net>
Date: Sat, 4 Oct 2003 13:04:01 +0000
Subject: [PATCH] Added a docstring and doctested nItems.

---
 src/utils.py | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/src/utils.py b/src/utils.py
index dec50c85b..81fd39bd4 100755
--- a/src/utils.py
+++ b/src/utils.py
@@ -287,6 +287,17 @@ def pluralize(i, s):
             return s + 's'
 
 def nItems(n, item, between=None):
+    """Works like this:
+
+    >>> nItems(1, 'clock')
+    '1 clock'
+
+    >>> nItems(10, 'clock')
+    '10 clocks'
+
+    >>> nItems(10, 'clock', between='grandfather')
+    '10 grandfather clocks'
+    """
     if between is None:
         return '%s %s' % (n, pluralize(n, item))
     else:
@@ -386,4 +397,8 @@ class IterableMap(object):
         return False
 
 
+if __name__ == '__main__':
+    import sys, doctest
+    doctest.testmod(sys.modules['__main__'])
+
 # vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78: