deploy: 07fe241

asai/Asai/Tty/Make/index.html

@@ -9,6 +9,7 @@
     ┷
  [E002] Why am I checking the term (→ ℕ (→ ℕ ℕ)),
         which looks amazing?</pre></header><nav class="odoc-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><div class="odoc-spec"><div class="spec parameter anchored" id="argument-1-Code"><a href="#argument-1-Code" class="anchor"></a><code><span><span class="keyword">module</span> </span><span><a href="argument-1-Code/index.html">Code</a></span><span> : <a href="../../Diagnostic/module-type-Code/index.html">Diagnostic.Code</a></span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><div class="odoc-spec"><div class="spec value anchored" id="val-display"><a href="#val-display" class="anchor"></a><code><span><span class="keyword">val</span> display : 
+  <span><span class="optlabel">?output</span>:<span class="xref-unresolved">Stdlib</span>.out_channel <span class="arrow">&#45;&gt;</span></span>
   <span><span class="optlabel">?show_backtrace</span>:bool <span class="arrow">&#45;&gt;</span></span>
   <span><span class="optlabel">?line_breaking</span>:<span>[ `Unicode <span>| `Traditional</span> ]</span> <span class="arrow">&#45;&gt;</span></span>
   <span><span class="optlabel">?block_splitting_threshold</span>:int <span class="arrow">&#45;&gt;</span></span>
@@ -31,9 +32,11 @@
     │
   8 │ assert (asai is cool)
     ┷
- [E002] Why am I checking the term (→ ℕ (→ ℕ ℕ))?</pre><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">show_backtrace</span> <p>Whether the backtrace should be shown. The default is <code>false</code>.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">line_breaking</span> <p>The algorithm to recognize (hard) line breaks. The <code>`Unicode</code> algorithm recognizes all Unicode character sequences in <a href="https://www.unicode.org/versions/Unicode15.0.0/ch05.pdf#G41643">Unicode 15.0.0 Table 5-1</a> as line breaks. The <code>`Traditional</code> algorithm only recognizes <code>U+000A (LF)</code>, <code>U+000D (CR)</code>, and <code>U+000D U+000A (CRLF)</code> as line breaks. The default is the <code>`Traditional</code> algorithm.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">block_splitting_threshold</span> <p>The maximum number of consecutive, non-highlighted lines allowed in a block. The function will try to minimize the number of blocks, as long as no block has too many consecutive, non-highlighted lines. A higher threshold will lead to fewer blocks. When the threshold is zero, it means no block can contain any non-highlighted line. The default value is <code>5</code>.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">tab_size</span> <p>The number of spaces that should be used to replace a horizontal tab. Note that a horizontal tab is always expanded to the same number of spaces. The result should still be visually appealing as long as horizontal tabs are only used at the beginning of lines. The default value is <code>8</code>.</p></li></ul><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Invalid_argument</code> <p>if <code>tab_size &lt; 0</code>.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-interactive_trace"><a href="#val-interactive_trace" class="anchor"></a><code><span><span class="keyword">val</span> interactive_trace : 
+ [E002] Why am I checking the term (→ ℕ (→ ℕ ℕ))?</pre><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">output</span> <p>The output channel, such as <code>stdout</code> and <code>stderr</code>. By default, it is <code>stdout</code>, the standard output.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">show_backtrace</span> <p>Whether the backtrace should be shown. The default is <code>false</code>.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">line_breaking</span> <p>The algorithm to recognize (hard) line breaks. The <code>`Unicode</code> algorithm recognizes all Unicode character sequences in <a href="https://www.unicode.org/versions/Unicode15.0.0/ch05.pdf#G41643">Unicode 15.0.0 Table 5-1</a> as line breaks. The <code>`Traditional</code> algorithm only recognizes <code>U+000A (LF)</code>, <code>U+000D (CR)</code>, and <code>U+000D U+000A (CRLF)</code> as line breaks. The default is the <code>`Traditional</code> algorithm.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">block_splitting_threshold</span> <p>The maximum number of consecutive, non-highlighted lines allowed in a block. The function will try to minimize the number of blocks, as long as no block has too many consecutive, non-highlighted lines. A higher threshold will lead to fewer blocks. When the threshold is zero, it means no block can contain any non-highlighted line. The default value is <code>5</code>.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">tab_size</span> <p>The number of spaces that should be used to replace a horizontal tab. Note that a horizontal tab is always expanded to the same number of spaces. The result should still be visually appealing as long as horizontal tabs are only used at the beginning of lines. The default value is <code>8</code>.</p></li></ul><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Invalid_argument</code> <p>if <code>tab_size &lt; 0</code>.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-interactive_trace"><a href="#val-interactive_trace" class="anchor"></a><code><span><span class="keyword">val</span> interactive_trace : 
+  <span><span class="optlabel">?input</span>:<span class="xref-unresolved">Unix</span>.file_descr <span class="arrow">&#45;&gt;</span></span>
+  <span><span class="optlabel">?output</span>:<span class="xref-unresolved">Unix</span>.file_descr <span class="arrow">&#45;&gt;</span></span>
   <span><span class="optlabel">?line_breaking</span>:<span>[ `Unicode <span>| `Traditional</span> ]</span> <span class="arrow">&#45;&gt;</span></span>
   <span><span class="optlabel">?block_splitting_threshold</span>:int <span class="arrow">&#45;&gt;</span></span>
   <span><span class="optlabel">?tab_size</span>:int <span class="arrow">&#45;&gt;</span></span>
   <span><span><a href="argument-1-Code/index.html#type-t">Code.t</a> <a href="../../Diagnostic/index.html#type-t">Diagnostic.t</a></span> <span class="arrow">&#45;&gt;</span></span>
-  unit</span></code></div><div class="spec-doc"><p><code>interactive_trace d</code> drops the user in a small interactive terminal app where they can cycle through the message provided in <code>d</code> and its backtrace.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">line_breaking</span> <p>The algorithm to recognize (hard) line breaks. The <code>`Unicode</code> algorithm recognizes all Unicode character sequences in <a href="https://www.unicode.org/versions/Unicode15.0.0/ch05.pdf#G41643">Unicode 15.0.0 Table 5-1</a> as line breaks. The <code>`Traditional</code> algorithm only recognizes <code>U+000A (LF)</code>, <code>U+000D (CR)</code>, and <code>U+000D U+000A (CRLF)</code> as line breaks. The default is the <code>`Traditional</code> algorithm.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">block_splitting_threshold</span> <p>The maximum number of consecutive, non-highlighted lines allowed in a block. The function will try to minimize the number of blocks, as long as no block has too many consecutive, non-highlighted lines. A higher threshold will lead to fewer blocks. When the threshold is zero, it means no block can contain any non-highlighted line. The default value is <code>5</code>.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">tab_size</span> <p>The number of spaces that should be used to replace a horizontal tab. Note that a horizontal tab is always expanded to the same number of spaces. The result should still be visually appealing as long as horizontal tabs are only used at the beginning of lines. The default value is <code>8</code>.</p></li></ul><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Invalid_argument</code> <p>if <code>tab_size &lt; 0</code>.</p></li></ul></div></div></div></body></html>
+  unit</span></code></div><div class="spec-doc"><p><code>interactive_trace d</code> drops the user in a small interactive terminal app where they can cycle through the message provided in <code>d</code> and its backtrace.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">input</span> <p>The input of the interactive app. By default, it is <code>Unix.stdin</code>, the standard input.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">output</span> <p>The output of the interactive app, By default, it is <code>Unix.stdout</code>, the standard output.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">line_breaking</span> <p>The algorithm to recognize (hard) line breaks. The <code>`Unicode</code> algorithm recognizes all Unicode character sequences in <a href="https://www.unicode.org/versions/Unicode15.0.0/ch05.pdf#G41643">Unicode 15.0.0 Table 5-1</a> as line breaks. The <code>`Traditional</code> algorithm only recognizes <code>U+000A (LF)</code>, <code>U+000D (CR)</code>, and <code>U+000D U+000A (CRLF)</code> as line breaks. The default is the <code>`Traditional</code> algorithm.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">block_splitting_threshold</span> <p>The maximum number of consecutive, non-highlighted lines allowed in a block. The function will try to minimize the number of blocks, as long as no block has too many consecutive, non-highlighted lines. A higher threshold will lead to fewer blocks. When the threshold is zero, it means no block can contain any non-highlighted line. The default value is <code>5</code>.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">tab_size</span> <p>The number of spaces that should be used to replace a horizontal tab. Note that a horizontal tab is always expanded to the same number of spaces. The result should still be visually appealing as long as horizontal tabs are only used at the beginning of lines. The default value is <code>8</code>.</p></li></ul><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Invalid_argument</code> <p>if <code>tab_size &lt; 0</code>.</p></li></ul></div></div></div></body></html>