Skip to content

Commit

Permalink
Fix @doc formatting for TimezoneInfo.create/6 (#754)
Browse files Browse the repository at this point in the history
  • Loading branch information
jonathanpglick authored Apr 24, 2024
1 parent 7f584ce commit c45b9a7
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).

- Updated `Timex.now/1` typespec to remove the `AmbiguousDateTime`
- Corrected pluralization rules for bg/cs/he/id/ro/ru
- Fixed documentation formatting of `Timex.TimezoneInfo.create/6`

---

Expand Down
16 changes: 8 additions & 8 deletions lib/timezone/timezone_info.ex
Original file line number Diff line number Diff line change
Expand Up @@ -50,16 +50,16 @@ defmodule Timex.TimezoneInfo do
during daylight savings time for this timezone. If DST does not apply for this zone, simply
set it to 0.
The from/until reference points must meet the following criteria:
The `from`/`until` reference points must meet the following criteria:
- Be set to `:min` for from, or `:max` for until, which represent
"infinity" for the start/end of the zone period.
- OR, be a tuple of {day_of_week, datetime}, where:
- `day_of_week` is an atom like `:sunday`
- `datetime` is an Erlang datetime tuple, e.g. `{{2016,10,8},{2,0,0}}`
- Be set to `:min` for `from`, or `:max` for `until`, which represents
"infinity" for the start/end of the zone period
- OR, be a tuple of `{day_of_week, datetime}`, where:
- `day_of_week` is an atom like `:sunday`
- `datetime` is an Erlang datetime tuple, e.g. `{{2016,10,8},{2,0,0}}`
*IMPORTANT*: Offsets are in seconds, not minutes, if you do not ensure they
are in the correct unit, runtime errors or incorrect results are probable.
**IMPORTANT**: Offsets are in seconds, not minutes. If you do not ensure they
are in the correct unit, runtime errors or incorrect results are probable.
## Examples
Expand Down

0 comments on commit c45b9a7

Please sign in to comment.