Update to use TZFile in docs

JuliaTime · Jun 17, 2022 · c4f36c8 · c4f36c8
1 parent 4ed324b
commit c4f36c8
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/docs/src/api-private.md b/docs/src/api-private.md
@@ -29,12 +29,18 @@ TimeZones.first_valid
 TimeZones.last_valid
 ```
 
+## TZFile
+
+```@docs
+TZFile.read
+TZFile.write
+```
+
 ## Etc.
 
 ```@docs
 TimeZones.UTCOffset
 TimeZones.@optional
-TimeZones.read_tzfile
 TimeZones.parse_tz_format
 TimeZones.tryparse_tz_format
 hash(::ZonedDateTime, ::UInt)

diff --git a/src/tzfile/write.jl b/src/tzfile/write.jl
@@ -39,6 +39,14 @@ function _combine_designations(abbrs::AbstractVector{<:AbstractString})
     return result, indices
 end
 
+"""
+    TZFile.write(io::IO, tz::TimeZone; version::Char=TZFile.WRITE_VERSION)
+
+Writes the time zone to the I/O stream in the
+[POSIX tzfile](https://data.iana.org/time-zones/data/tzfile.5.txt) format.
+"""
+function write end
+
 function write(io::IO, tz::FixedTimeZone; version::Char=WRITE_VERSION)
     combined_designation, designation_indices = combine_designations([tz.name])