Skip to content

Commit

Permalink
Deploying to gh-pages from @ eb1a573 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@darrenldl
darrenldl committed Apr 27, 2024
1 parent 04ec8f8 commit cc73bd1
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion timedesc/Timedesc/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@
<span><a href="Date/index.html#type-t">Date.t</a> <span class="arrow">&#45;&gt;</span></span>
<span><a href="Time/index.html#type-t">Time.t</a> <span class="arrow">&#45;&gt;</span></span>
<a href="#type-t">t</a></span></code></div><div class="spec-doc"><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <a href="#exception-Error_exn"><code>Error_exn</code></a> <p>if <code>of_date_and_time_unambiguous</code> fails</p></li></ul></div></div><h3 id="accessors"><a href="#accessors" class="anchor"></a>Accessors</h3><div class="odoc-spec"><div class="spec value anchored" id="val-date"><a href="#val-date" class="anchor"></a><code><span><span class="keyword">val</span> date : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="Date/index.html#type-t">Date.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ymd_date"><a href="#val-ymd_date" class="anchor"></a><code><span><span class="keyword">val</span> ymd_date : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="Date/Ymd/index.html#type-view">Date.Ymd.view</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-iso_week_date"><a href="#val-iso_week_date" class="anchor"></a><code><span><span class="keyword">val</span> iso_week_date : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="Date/ISO_week_date/index.html#type-view">Date.ISO_week_date.view</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-iso_ord_date"><a href="#val-iso_ord_date" class="anchor"></a><code><span><span class="keyword">val</span> iso_ord_date : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="Date/ISO_ord/index.html#type-view">Date.ISO_ord.view</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ym"><a href="#val-ym" class="anchor"></a><code><span><span class="keyword">val</span> ym : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="Ym/index.html#type-t">Ym.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-year"><a href="#val-year" class="anchor"></a><code><span><span class="keyword">val</span> year : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-month"><a href="#val-month" class="anchor"></a><code><span><span class="keyword">val</span> month : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-day"><a href="#val-day" class="anchor"></a><code><span><span class="keyword">val</span> day : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-iso_week"><a href="#val-iso_week" class="anchor"></a><code><span><span class="keyword">val</span> iso_week : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="ISO_week/index.html#type-t">ISO_week.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-iso_year"><a href="#val-iso_year" class="anchor"></a><code><span><span class="keyword">val</span> iso_year : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-weekday"><a href="#val-weekday" class="anchor"></a><code><span><span class="keyword">val</span> weekday : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-weekday">weekday</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-day_of_year"><a href="#val-day_of_year" class="anchor"></a><code><span><span class="keyword">val</span> day_of_year : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-time"><a href="#val-time" class="anchor"></a><code><span><span class="keyword">val</span> time : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="Time/index.html#type-t">Time.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-time_view"><a href="#val-time_view" class="anchor"></a><code><span><span class="keyword">val</span> time_view : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="Time/index.html#type-view">Time.view</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-hour"><a href="#val-hour" class="anchor"></a><code><span><span class="keyword">val</span> hour : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-minute"><a href="#val-minute" class="anchor"></a><code><span><span class="keyword">val</span> minute : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-second"><a href="#val-second" class="anchor"></a><code><span><span class="keyword">val</span> second : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ns"><a href="#val-ns" class="anchor"></a><code><span><span class="keyword">val</span> ns : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_leap_second"><a href="#val-is_leap_second" class="anchor"></a><code><span><span class="keyword">val</span> is_leap_second : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-tz"><a href="#val-tz" class="anchor"></a><code><span><span class="keyword">val</span> tz : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="Time_zone/index.html#type-t">Time_zone.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-offset_from_utc"><a href="#val-offset_from_utc" class="anchor"></a><code><span><span class="keyword">val</span> offset_from_utc : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="Span/index.html#type-t">Span.t</a> <a href="#type-local_date_time_result">local_date_time_result</a></span></span></code></div></div><h3 id="conversion"><a href="#conversion" class="anchor"></a>Conversion</h3><div class="odoc-spec"><div class="spec value anchored" id="val-to_timestamp"><a href="#val-to_timestamp" class="anchor"></a><code><span><span class="keyword">val</span> to_timestamp : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-timestamp">timestamp</a> <a href="#type-local_date_time_result">local_date_time_result</a></span></span></code></div><div class="spec-doc"><p><code>to_timestamp</code> loses information about leap second</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_timestamp_single"><a href="#val-to_timestamp_single" class="anchor"></a><code><span><span class="keyword">val</span> to_timestamp_single : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-timestamp">timestamp</a></span></code></div><div class="spec-doc"><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Invalid_argument</code> <p>if <code>to_timestamp</code> does not yield a <code>`Single</code> result</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_timestamp_float_s"><a href="#val-to_timestamp_float_s" class="anchor"></a><code><span><span class="keyword">val</span> to_timestamp_float_s : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>float <a href="#type-local_date_time_result">local_date_time_result</a></span></span></code></div><div class="spec-doc"><p>Returns timestamp in seconds, fraction represent</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_timestamp_float_s_single"><a href="#val-to_timestamp_float_s_single" class="anchor"></a><code><span><span class="keyword">val</span> to_timestamp_float_s_single : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> float</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Invalid_argument</code> <p>if <code>to_timestamp_float_s</code> does not yield a <code>`Single</code> result</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_timestamp"><a href="#val-of_timestamp" class="anchor"></a><code><span><span class="keyword">val</span> of_timestamp : <span><span class="optlabel">?tz_of_date_time</span>:<a href="Time_zone/index.html#type-t">Time_zone.t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-timestamp">timestamp</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_timestamp_exn"><a href="#val-of_timestamp_exn" class="anchor"></a><code><span><span class="keyword">val</span> of_timestamp_exn : <span><span class="optlabel">?tz_of_date_time</span>:<a href="Time_zone/index.html#type-t">Time_zone.t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-timestamp">timestamp</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_timestamp_float_s"><a href="#val-of_timestamp_float_s" class="anchor"></a><code><span><span class="keyword">val</span> of_timestamp_float_s : <span><span class="optlabel">?tz_of_date_time</span>:<a href="Time_zone/index.html#type-t">Time_zone.t</a> <span class="arrow">&#45;&gt;</span></span> <span>float <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_timestamp_float_s_exn"><a href="#val-of_timestamp_float_s_exn" class="anchor"></a><code><span><span class="keyword">val</span> of_timestamp_float_s_exn : <span><span class="optlabel">?tz_of_date_time</span>:<a href="Time_zone/index.html#type-t">Time_zone.t</a> <span class="arrow">&#45;&gt;</span></span> <span>float <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><h3 id="comparison"><a href="#comparison" class="anchor"></a>Comparison</h3><div class="odoc-spec"><div class="spec value anchored" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span><span class="keyword">val</span> equal : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-compare_chrono_min"><a href="#val-compare_chrono_min" class="anchor"></a><code><span><span class="keyword">val</span> compare_chrono_min : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p>Compare based on ordering of <code>min_of_local_date_time_result @@ to_timestamp _</code></p><p><b>Warning</b>: <code>compare_chrono_min x y = 0</code> does not imply <code>equal x y</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-compare_chrono_max"><a href="#val-compare_chrono_max" class="anchor"></a><code><span><span class="keyword">val</span> compare_chrono_max : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p>Compare based on ordering of <code>max_of_local_date_time_result @@ to_timestamp _</code></p><p><b>Warning</b>: <code>compare_chrono_max x y = 0</code> does not imply <code>equal x y</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-compare_struct"><a href="#val-compare_struct" class="anchor"></a><code><span><span class="keyword">val</span> compare_struct : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p>Structural comparison, <code>compare_struct x y = 0</code> implies <code>equal x y</code></p><p>Ordering does not correspond to chronological ordering</p></div></div><h3 id="constants"><a href="#constants" class="anchor"></a>Constants</h3><div class="odoc-spec"><div class="spec value anchored" id="val-min_val"><a href="#val-min_val" class="anchor"></a><code><span><span class="keyword">val</span> min_val : <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-max_val"><a href="#val-max_val" class="anchor"></a><code><span><span class="keyword">val</span> max_val : <a href="#type-t">t</a></span></code></div></div><h3 id="now"><a href="#now" class="anchor"></a>Now</h3><div class="odoc-spec"><div class="spec value anchored" id="val-now"><a href="#val-now" class="anchor"></a><code><span><span class="keyword">val</span> now : <span><span class="optlabel">?tz_of_date_time</span>:<a href="Time_zone/index.html#type-t">Time_zone.t</a> <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><h3 id="pretty-printing"><a href="#pretty-printing" class="anchor"></a>Pretty-printing</h3><div class="odoc-spec"><div class="spec exception anchored" id="exception-Date_time_cannot_deduce_offset_from_utc"><a href="#exception-Date_time_cannot_deduce_offset_from_utc" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">Date_time_cannot_deduce_offset_from_utc</span> <span class="keyword">of</span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp"><a href="#val-pp" class="anchor"></a><code><span><span class="keyword">val</span> pp : <span><span class="optlabel">?format</span>:string <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Pretty-printing for date time.</p><p>Default format string:</p><pre>{year} {mon:Xxx} {day:0X} {hour:0X}:{min:0X}:{sec:0X}{sec-frac:.} \
{tzoff-sign}{tzoff-hour:0X}:{tzoff-min:0X}:{tzoff-sec:0X}</pre><p>Format string specification:</p><pre>{{ literal {
{tzoff-sign}{tzoff-hour:0X}:{tzoff-min:0X}:{tzoff-sec:0X}</pre><p>Format string specification:</p><pre>{{ Literal {
{year} Year

{mon:Xxx} Abbreviated month name (e.g. Jan), casing of 'X'/'x' controls the casing
Expand Down

0 comments on commit cc73bd1

Please sign in to comment.