Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve documentation for utc_offset and std_offset fields. #10014

Merged
merged 4 commits into from May 3, 2020
Merged

Improve documentation for utc_offset and std_offset fields. #10014

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8c335cc
Improve documentation for utc_offset and std_offset fields.
lau May 2, 2020
bf30b6d
Apply suggestions from code review
josevalim May 3, 2020
7c658e6
Apply suggestions from code review
josevalim May 3, 2020
d7fc5c5
Update lib/elixir/lib/calendar.ex
josevalim May 3, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 5 additions & 2 deletions lib/elixir/lib/calendar.ex
View file
Open in desktop
Expand Up @@ -68,10 +68,13 @@ defmodule Calendar do
@typedoc "The time zone abbreviation (for example, CET or CEST or BST, and such)"
@type zone_abbr :: String.t()

@typedoc "The time zone UTC offset in seconds"
@typedoc "The time zone UTC offset in seconds for standard time. See also `std_offset`."
josevalim marked this conversation as resolved.
Show resolved Hide resolved
@type utc_offset :: integer

@typedoc "The time zone standard offset in seconds (not zero in summer times)"
@typedoc """
The time zone standard offset in seconds (typically not zero in summer times). Is added to
`utc_offset` to get the total offset from UTC used for "wall time".
josevalim marked this conversation as resolved.
Show resolved Hide resolved
"""
@type std_offset :: integer

@typedoc "Any map/struct that contains the date fields"
Expand Down