Skip to content

Commit c45b9a7

Browse files
Fix @doc formatting for TimezoneInfo.create/6 (#754)
1 parent 7f584ce commit c45b9a7

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
1616

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

2021
---
2122

lib/timezone/timezone_info.ex

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,16 +50,16 @@ defmodule Timex.TimezoneInfo do
5050
during daylight savings time for this timezone. If DST does not apply for this zone, simply
5151
set it to 0.
5252
53-
The from/until reference points must meet the following criteria:
53+
The `from`/`until` reference points must meet the following criteria:
5454
55-
- Be set to `:min` for from, or `:max` for until, which represent
56-
"infinity" for the start/end of the zone period.
57-
- OR, be a tuple of {day_of_week, datetime}, where:
58-
- `day_of_week` is an atom like `:sunday`
59-
- `datetime` is an Erlang datetime tuple, e.g. `{{2016,10,8},{2,0,0}}`
55+
- Be set to `:min` for `from`, or `:max` for `until`, which represents
56+
"infinity" for the start/end of the zone period
57+
- OR, be a tuple of `{day_of_week, datetime}`, where:
58+
- `day_of_week` is an atom like `:sunday`
59+
- `datetime` is an Erlang datetime tuple, e.g. `{{2016,10,8},{2,0,0}}`
6060
61-
*IMPORTANT*: Offsets are in seconds, not minutes, if you do not ensure they
62-
are in the correct unit, runtime errors or incorrect results are probable.
61+
**IMPORTANT**: Offsets are in seconds, not minutes. If you do not ensure they
62+
are in the correct unit, runtime errors or incorrect results are probable.
6363
6464
## Examples
6565

0 commit comments

Comments
 (0)