build based on 7021e4e

dev/api-private/index.html

@@ -44,4 +44,4 @@
 1919-09-16   2:00s   0       -
 1944-04-03   2:00s   1:00    S</code></pre></div></section></article><h2 id="Interpretation"><a class="docs-heading-anchor" href="#Interpretation">Interpretation</a><a id="Interpretation-1"></a><a class="docs-heading-anchor-permalink" href="#Interpretation" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="TimeZones.transition_range" href="#TimeZones.transition_range"><code>TimeZones.transition_range</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">transition_range(dt::DateTime, tz::VariableTimeZone, context::Type{Union{Local,UTC}}) -&gt; UnitRange</code></pre><p>Finds the indexes of the <code>tz</code> transitions which may be applicable for the <code>dt</code>. The given DateTime is expected to be local to the time zone or in UTC as specified by <code>context</code>. Note that UTC context will always return a range of length one.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="TimeZones.interpret" href="#TimeZones.interpret"><code>TimeZones.interpret</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">interpret(dt::DateTime, tz::VariableTimeZone, context::Type{Union{Local,UTC}}) -&gt; Array{ZonedDateTime}</code></pre><p>Produces a list of possible <code>ZonedDateTime</code>s given a <code>DateTime</code> and <code>VariableTimeZone</code>. The result will be returned in chronological order. Note that <code>DateTime</code>s in the local context typically return 0-2 results while the UTC context will always return 1 result.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="TimeZones.shift_gap" href="#TimeZones.shift_gap"><code>TimeZones.shift_gap</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">shift_gap(local_dt::DateTime, tz::VariableTimeZone) -&gt; Tuple</code></pre><p>Given a non-existent local <code>DateTime</code> in a <code>TimeZone</code> produces a tuple containing two valid <code>ZonedDateTime</code>s that span the gap. Providing a valid local <code>DateTime</code> returns an empty tuple. Note that this function does not support passing in a UTC <code>DateTime</code> since there are no non-existent UTC <code>DateTime</code>s.</p><p>Aside: the function name refers to a period of invalid local time (gap) caused by daylight saving time or offset changes (shift).</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="TimeZones.first_valid" href="#TimeZones.first_valid"><code>TimeZones.first_valid</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">first_valid(local_dt::DateTime, tz::VariableTimeZone, step::Period)</code></pre><p>Construct a valid <code>ZonedDateTime</code> by adjusting the local <code>DateTime</code>. If the local <code>DateTime</code> is non-existent then it will be adjusted using the <code>step</code> to be <em>after</em> the gap. When the local <code>DateTime</code> is ambiguous the <em>first</em> ambiguous <code>DateTime</code> will be returned.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="TimeZones.last_valid" href="#TimeZones.last_valid"><code>TimeZones.last_valid</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">last_valid(local_dt::DateTime, tz::VariableTimeZone, step::Period)</code></pre><p>Construct a valid <code>ZonedDateTime</code> by adjusting the local <code>DateTime</code>. If the local <code>DateTime</code> is non-existent then it will be adjusted using the <code>step</code> to be <em>before</em> the gap. When the local <code>DateTime</code> is ambiguous the <em>last</em> ambiguous <code>DateTime</code> will be returned.</p></div></section></article><h2 id="TZFile"><a class="docs-heading-anchor" href="#TZFile">TZFile</a><a id="TZFile-1"></a><a class="docs-heading-anchor-permalink" href="#TZFile" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="TimeZones.TZFile.read" href="#TimeZones.TZFile.read"><code>TimeZones.TZFile.read</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">TZFile.read(io::IO) -&gt; Function</code></pre><p>Read the content of an I/O stream as a <a href="https://data.iana.org/time-zones/data/tzfile.5.txt">POSIX tzfile</a> to produce a <code>TimeZone</code>. As the tzfile format does not include the name of the interpreted time zone this function returns a closure which takes the single argument <code>name::AbstractString</code> and when called produces a <code>TimeZone</code> instance.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="TimeZones.TZFile.write" href="#TimeZones.TZFile.write"><code>TimeZones.TZFile.write</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">TZFile.write(io::IO, tz::TimeZone; version::Char=TZFile.WRITE_VERSION)</code></pre><p>Writes the time zone to the I/O stream in the <a href="https://data.iana.org/time-zones/data/tzfile.5.txt">POSIX tzfile</a> format.</p></div></section></article><h2 id="Etc."><a class="docs-heading-anchor" href="#Etc.">Etc.</a><a id="Etc.-1"></a><a class="docs-heading-anchor-permalink" href="#Etc." title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="TimeZones.UTCOffset" href="#TimeZones.UTCOffset"><code>TimeZones.UTCOffset</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">UTCOffset</code></pre><p>A <code>UTCOffset</code> is an amount of time subtracted from or added to UTC to get the current local time – whether it&#39;s standard time or daylight saving time.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="TimeZones.@optional" href="#TimeZones.@optional"><code>TimeZones.@optional</code></a> — <span class="docstring-category">Macro</span></header><section><div><pre><code class="language-julia hljs">@optional(expr)</code></pre><p>Creates multiple method signatures to allow optional arguments before required arguments. For example:</p><pre><code class="nohighlight hljs">f(a=1, b=2, c) = ...</code></pre><p>becomes:</p><pre><code class="nohighlight hljs">f(a, b, c) = ...
 f(a, c) = f(a, 2, c)
-f(c) = f(1, 2, c)</code></pre></div></section></article><article class="docstring"><header><a class="docstring-binding" id="TimeZones.parse_tz_format" href="#TimeZones.parse_tz_format"><code>TimeZones.parse_tz_format</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">parse_tz_format(str) -&gt; TimeZone</code></pre><p>Parse the time zone format typically provided via the &quot;TZ&quot; environment variable. Details on the format can be found under the man page for <a href="https://man7.org/linux/man-pages/man3/tzset.3.html">tzset</a>.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="TimeZones.tryparse_tz_format" href="#TimeZones.tryparse_tz_format"><code>TimeZones.tryparse_tz_format</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">tryparse_tz_format(str) -&gt; Union{TimeZone, Nothing}</code></pre><p>Like <code>parse_tz_format</code>, but returns either a value of the <code>TimeZone</code>, or <code>nothing</code> if the string does not contain a valid format.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="Base.hash-Tuple{ZonedDateTime, UInt64}" href="#Base.hash-Tuple{ZonedDateTime, UInt64}"><code>Base.hash</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">hash(::ZonedDateTime, h)</code></pre><p>Compute an integer hash code for a ZonedDateTime by hashing the <code>utc_datetime</code> field. <code>hash(:utc_instant, h)</code> is used to avoid collisions with <code>DateTime</code> hashes.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="Dates.guess-Tuple{ZonedDateTime, ZonedDateTime, Any}" href="#Dates.guess-Tuple{ZonedDateTime, ZonedDateTime, Any}"><code>Dates.guess</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">guess(start::ZonedDateTime, finish::ZonedDateTime, step) -&gt; Integer</code></pre><p>Given a start and end date, indicates how many steps/periods are between them. Defining this function allows <code>StepRange</code>s to be defined for <code>ZonedDateTime</code>s.</p></div></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../api-public/">« API – Public</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 25 December 2024 02:49">Wednesday 25 December 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+f(c) = f(1, 2, c)</code></pre></div></section></article><article class="docstring"><header><a class="docstring-binding" id="TimeZones.parse_tz_format" href="#TimeZones.parse_tz_format"><code>TimeZones.parse_tz_format</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">parse_tz_format(str) -&gt; TimeZone</code></pre><p>Parse the time zone format typically provided via the &quot;TZ&quot; environment variable. Details on the format can be found under the man page for <a href="https://man7.org/linux/man-pages/man3/tzset.3.html">tzset</a>.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="TimeZones.tryparse_tz_format" href="#TimeZones.tryparse_tz_format"><code>TimeZones.tryparse_tz_format</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">tryparse_tz_format(str) -&gt; Union{TimeZone, Nothing}</code></pre><p>Like <code>parse_tz_format</code>, but returns either a value of the <code>TimeZone</code>, or <code>nothing</code> if the string does not contain a valid format.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="Base.hash-Tuple{ZonedDateTime, UInt64}" href="#Base.hash-Tuple{ZonedDateTime, UInt64}"><code>Base.hash</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">hash(::ZonedDateTime, h)</code></pre><p>Compute an integer hash code for a ZonedDateTime by hashing the <code>utc_datetime</code> field. <code>hash(:utc_instant, h)</code> is used to avoid collisions with <code>DateTime</code> hashes.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="Dates.guess-Tuple{ZonedDateTime, ZonedDateTime, Any}" href="#Dates.guess-Tuple{ZonedDateTime, ZonedDateTime, Any}"><code>Dates.guess</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">guess(start::ZonedDateTime, finish::ZonedDateTime, step) -&gt; Integer</code></pre><p>Given a start and end date, indicates how many steps/periods are between them. Defining this function allows <code>StepRange</code>s to be defined for <code>ZonedDateTime</code>s.</p></div></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../api-public/">« API – Public</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Thursday 26 December 2024 02:50">Thursday 26 December 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/api-public/index.html

@@ -127,4 +127,4 @@
 Local Time Change: 00:00 → 00:00 (Forward)
 Offset Change:     UTC-11/+1 → UTC+13/+1
 Transition From:   2011-12-29T23:59:59.999-10:00
-Transition To:     2011-12-31T00:00:00.000+14:00</code></pre></div></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../faq/">« Frequently Asked Questions</a><a class="docs-footer-nextpage" href="../api-private/">API – Private »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 25 December 2024 02:49">Wednesday 25 December 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+Transition To:     2011-12-31T00:00:00.000+14:00</code></pre></div></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../faq/">« Frequently Asked Questions</a><a class="docs-footer-nextpage" href="../api-private/">API – Private »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Thursday 26 December 2024 02:50">Thursday 26 December 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/arithmetic/index.html

@@ -52,4 +52,4 @@
  2016-01-01T14:00:00+00:00
  2016-01-01T15:00:00+00:00
  2016-01-01T16:00:00+00:00
- 2016-01-01T17:00:00+00:00</code></pre><p>Note that 2016-01-01T17:00:00 in UTC corresponds to 2016-01-01T18:00:00 in &quot;Europe/Warsaw&quot;, which is the requested endpoint of the range.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../conversions/">« Converting</a><a class="docs-footer-nextpage" href="../rounding/">Rounding »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 25 December 2024 02:49">Wednesday 25 December 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+ 2016-01-01T17:00:00+00:00</code></pre><p>Note that 2016-01-01T17:00:00 in UTC corresponds to 2016-01-01T18:00:00 in &quot;Europe/Warsaw&quot;, which is the requested endpoint of the range.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../conversions/">« Converting</a><a class="docs-footer-nextpage" href="../rounding/">Rounding »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Thursday 26 December 2024 02:50">Thursday 26 December 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>