update docs

samuelcolvin · Mar 5, 2022 · 9f71c29 · 9f71c29
1 parent 2cfeefa
commit 9f71c29
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/dirty_equals/_datetime.py b/dirty_equals/_datetime.py
@@ -203,6 +203,8 @@ def __init__(
         """
         Args:
             approx: A value to approximately compare to.
+            delta: The allowable different when comparing to the value to now, if omitted 2 seconds is used,
+                ints and floats are assumed to represent seconds and converted to `timedelta`s.
             gt: Value which the compared value should be greater than (after).
             lt: Value which the compared value should be less than (before).
             ge: Value which the compared value should be greater than (after) or equal to.

diff --git a/docs/types/datetime.md b/docs/types/datetime.md
@@ -46,3 +46,7 @@ assert new_year_eve_nyc != IsDatetime(approx=new_year_naive, enforce_tz=False)
 ```
 
 ::: dirty_equals.IsNow
+
+::: dirty_equals.IsDate
+
+::: dirty_equals.IsToday