fixup! Extend documentation of Time and Time::Location APIs

crystal-lang · Apr 26, 2018 · 6fab9e4 · 6fab9e4
1 parent 2e963a5
commit 6fab9e4
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/time/location.cr b/src/time/location.cr
@@ -88,6 +88,9 @@ class Time::Location
     # Creates a new `Zone` named *name* with *offset* from UTC in seconds.
     # The parameter *dst* is used to declare this zone as daylight savings time.
     #
+    # If `name` is `nil`, the formatted `offset` will be used as `name` (see
+    # `#format`).
+    #
     # Raises `InvalidTimezoneOffsetError` if *seconds* is outside the supported
     # value range `-86_400..86_400` seconds (`-24:00` to `+24:00`).
     def initialize(@name : String?, @offset : Int32, @dst : Bool)