Changes to for_humans() of the interval class to in_words()

Author: sdispater

docs/index.rst

@@ -1086,8 +1086,27 @@ you can use the appropriate methods.
     it.total_seconds()
     101700084.001234
 
-It also has a handy ``for_humans()``, which determines the interval representation when printed,
-that prints the interval for humans.
+Similarly, it has the ``in_xxx()`` methods which returns to total duration in each
+supported unit as a truncated integer.
+
+.. code-block:: python
+
+    it.in_weeks()
+    168
+
+    it.in_days()
+    1177
+
+    it.in_hours()
+    28250
+
+    it.in_minutes()
+    1695001
+
+    it.in_seconds()
+    101700084
+
+It also has a handy ``in_words()``, which determines the interval representation when printed.
 
 .. code-block:: python
 
@@ -1098,11 +1117,11 @@ that prints the interval for humans.
 
     it = pendulum.interval(days=1177, seconds=7284, microseconds=1234)
 
-    it.for_humans()
+    it.in_words()
     '168 semaines 1 jour 2 heures 1 minute 24 secondes'
 
     print(it)
     '168 semaines 1 jour 2 heures 1 minute 24 secondes'
 
-    it.for_humans(locale='de')
+    it.in_words(locale='de')
     '168 Wochen 1 Tag 2 Stunden 1 Minute 24 Sekunden'

pendulum/pendulum_interval.py

@@ -199,10 +199,11 @@ def _sign(self, value):
 
         return 1
 
-    def for_humans(self, locale=None):
+    def in_words(self, locale=None):
         """
-        Get the current interval in a human readable format
-        in the current locale.
+        Get the current interval in words in the current locale.
+
+        Ex: 6 jours 23 heures 58 minutes
 
         :rtype: str
         """

tests/interval_tests/test_for_humans.py tests/interval_tests/test_in_words.pytests/interval_tests/test_for_humans.py renamed to tests/interval_tests/test_in_words.py

@@ -13,26 +13,26 @@ def setUp(self):
         PendulumInterval.set_locale('en')
 
     def test_week(self):
-        self.assertEqual('52 weeks', PendulumInterval(days=364).for_humans())
+        self.assertEqual('52 weeks', PendulumInterval(days=364).in_words())
         self.assertEqual('1 week', PendulumInterval(days=7).for_humans())
 
     def test_week_to_string(self):
         self.assertEqual('52 weeks', str(PendulumInterval(days=364)))
         self.assertEqual('1 week', str(PendulumInterval(days=7)))
 
     def test_weeks_and_day(self):
-        self.assertEqual('52 weeks 1 day', PendulumInterval(days=365).for_humans())
+        self.assertEqual('52 weeks 1 day', PendulumInterval(days=365).in_words())
 
     def test_all(self):
         pi = PendulumInterval(days=1177, seconds=7284, microseconds=1000000)
         self.assertEqual(
             '168 weeks 1 day 2 hours 1 minute 25 seconds',
-            pi.for_humans()
+            pi.in_words()
         )
 
     def test_in_french(self):
         pi = PendulumInterval(days=1177, seconds=7284, microseconds=1000000)
         self.assertEqual(
             '168 semaines 1 jour 2 heures 1 minute 25 secondes',
-            pi.for_humans(locale='fr')
+            pi.in_words(locale='fr')
         )