From 9f05a0ffc83c7dc6f7f6972ec9067d9dc73d519c Mon Sep 17 00:00:00 2001 From: Edouard Menayde Date: Tue, 30 Jan 2018 22:21:33 +0100 Subject: [PATCH] Add documentation concerning interval test (#408) --- docs/Basic Usage.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/Basic Usage.md b/docs/Basic Usage.md index 2715e5a7..bb0b7e6e 100644 --- a/docs/Basic Usage.md +++ b/docs/Basic Usage.md @@ -65,3 +65,18 @@ iex> Timex.format!(Timex.to_datetime(~N[2015-06-24T00:04:09.293], "America/Chica iex> Timex.format!(Timex.to_datetime(~N[2015-06-24T00:04:09.293], "America/Chicago"), "{ISO:Extended:Z}") "2015-06-24T05:04:13.293Z" ``` + +## Testing if one event occurs in an interval + +```elixir +iex> use Timex +...> event = Timex.to_datetime({{2016, 6, 24}, {0, 0, 0}}) +...> other_event = Timex.to_datetime({{2010, 1, 1}, {0, 0, 0}}) +...> from = Timex.to_datetime({{2015, 1, 1}, {0, 0, 0}}) +...> until = Timex.to_datetime({{2018, 1, 1}, {0, 0, 0}}) +...> interval = Timex.Interval.new(from: from, until: until) +...> event in interval +true +...> other_event in interval +false +```