diff options
author | Josh Price <josh@alembic.com.au> | 2017-11-21 02:48:21 +1100 |
---|---|---|
committer | José Valim <jose.valim@gmail.com> | 2017-11-20 13:48:21 -0200 |
commit | 80a85918965114099bc1ba4cb43a99498a6497ec (patch) | |
tree | f89a4b38752c22c6931bcc96a6c97daf98d7a842 | |
parent | d8a533d19f3a016512f605ac125e2709c6bd74ae (diff) | |
download | elixir-80a85918965114099bc1ba4cb43a99498a6497ec.tar.gz |
Update docs for DateTime.compare/2 (#7048)
Add missing `the` and make the references to UTC and Standard offsets consistent with the other docs.
-rw-r--r-- | lib/elixir/lib/calendar/datetime.ex | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/lib/elixir/lib/calendar/datetime.ex b/lib/elixir/lib/calendar/datetime.ex index abb485fb9..b011865bf 100644 --- a/lib/elixir/lib/calendar/datetime.ex +++ b/lib/elixir/lib/calendar/datetime.ex @@ -610,11 +610,11 @@ defmodule DateTime do @doc """ Compares two datetime structs. - Returns `:gt` if first datetime is later than the second + Returns `:gt` if the first datetime is later than the second and `:lt` for vice versa. If the two datetimes are equal `:eq` is returned. - Note that both utc and stc offsets will be taken into + Note that both UTC and Standard offsets will be taken into account when comparison is done. ## Examples |