Merge pull request #36475 from mrdofu/stdlib-docstrings

added documentation for Dates.TimeZone, Dates.UTC
JuliaLang · Jul 7, 2020 · 3d97a82 · 3d97a82
2 parents df8f8ae + 7927e15
commit 3d97a82
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/stdlib/Dates/docs/src/index.md b/stdlib/Dates/docs/src/index.md
@@ -643,6 +643,8 @@ Dates.TimeType
 Dates.DateTime
 Dates.Date
 Dates.Time
+Dates.TimeZone
+Dates.UTC
 ```
 
 ## Dates Functions

diff --git a/stdlib/Dates/src/types.jl b/stdlib/Dates/src/types.jl
@@ -85,7 +85,21 @@ abstract type Calendar <: AbstractTime end
 # ISOCalendar provides interpretation rules for UTInstants to civil date and time parts
 struct ISOCalendar <: Calendar end
 
+"""
+    TimeZone
+
+Geographic zone generally based on longitude determining what the time is at a certain location.
+Some time zones observe daylight savings (eg EST -> EDT).
+For implementations and more support, see the [`TimeZones.jl`](https://github.com/JuliaTime/TimeZones.jl) package
+"""
 abstract type TimeZone end
+
+"""
+    UTC
+
+`UTC`, or Coordinated Universal Time, is the [`TimeZone`](@ref) from which all others are measured.
+It is associated with the time at 0° longitude. It is not adjusted for daylight savings.
+"""
 struct UTC <: TimeZone end
 
 """