Updating guides on distance_of_time_in_words with Time Span overload. F…

…ixes #1292
luckyframework · Jul 21, 2024 · bac9be4 · bac9be4
1 parent 30c7eb6
commit bac9be4
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/actions/guides/frontend/rendering_html.cr b/src/actions/guides/frontend/rendering_html.cr
@@ -666,6 +666,14 @@ class Guides::Frontend::RenderingHtml < GuideAction
     # => "almost 42 years"
     ```
 
+    You can also pass in a `Time::Span` object to get a String representation.
+
+    ```crystal
+    distance_of_time_in_words(5.seconds)  # => "5 seconds"
+    distance_of_time_in_words(25.minutes) # => "25 minutes"
+    distance_of_time_in_words(2.days)     # => "2 days"
+    ```
+
     ### Time ago in words
 
     Similar to `distance_of_time_in_words`.