deploy: 7d46e57

asai/Asai/Diagnostic/index.html

@@ -9,13 +9,7 @@
   <span>?loc:<a href="../Span/index.html#type-t">Span.t</a> <span class="arrow">&#45;&gt;</span></span>
   <span><span>(<span><a href="#type-message">message</a> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'b</span>)</span> <span class="arrow">&#45;&gt;</span></span>
   <span><span><span>(<span class="type-var">'a</span>, <span class="xref-unresolved">Stdlib</span>.Format.formatter, unit, <span class="type-var">'b</span>)</span> <span class="xref-unresolved">Stdlib</span>.format4</span> <span class="arrow">&#45;&gt;</span></span>
-  <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>kmessagef kont format ...</code> is <code>kont (messagef code format ...)</code>.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">loc</span> <p>The location of the message (usually the code) to highlight.</p></li></ul></div></div><h2 id="constructions-of-diagnostics"><a href="#constructions-of-diagnostics" class="anchor"></a>Constructions of Diagnostics</h2><div class="odoc-spec"><div class="spec value anchored" id="val-of_message"><a href="#val-of_message" class="anchor"></a><code><span><span class="keyword">val</span> of_message : 
-  <span>?backtrace:<a href="#type-backtrace">backtrace</a> <span class="arrow">&#45;&gt;</span></span>
-  <span>?additional_messages:<span><a href="#type-message">message</a> list</span> <span class="arrow">&#45;&gt;</span></span>
-  <span><a href="#type-severity">severity</a> <span class="arrow">&#45;&gt;</span></span>
-  <span><span class="type-var">'code</span> <span class="arrow">&#45;&gt;</span></span>
-  <span><a href="#type-message">message</a> <span class="arrow">&#45;&gt;</span></span>
-  <span><span class="type-var">'code</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>of_message severity code message</code> constructs a diagnostic with the <code>message</code>.</p><p>Example:</p><pre class="language-ocaml"><code>make Warning `ChiError @@ message &quot;Your Ch'i is critically low&quot;</code></pre><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">backtrace</span> <p>The backtrace (to overwrite the accumulative frames up to this point).</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">additional_messages</span> <p>Additional messages that part of the backtrace. For example, they can be bindings shadowed by the current one.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make"><a href="#val-make" class="anchor"></a><code><span><span class="keyword">val</span> make : 
+  <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>kmessagef kont format ...</code> is <code>kont (messagef code format ...)</code>.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">loc</span> <p>The location of the message (usually the code) to highlight.</p></li></ul></div></div><h2 id="constructions-of-diagnostics"><a href="#constructions-of-diagnostics" class="anchor"></a>Constructions of Diagnostics</h2><div class="odoc-spec"><div class="spec value anchored" id="val-make"><a href="#val-make" class="anchor"></a><code><span><span class="keyword">val</span> make : 
   <span>?loc:<a href="../Span/index.html#type-t">Span.t</a> <span class="arrow">&#45;&gt;</span></span>
   <span>?backtrace:<a href="#type-backtrace">backtrace</a> <span class="arrow">&#45;&gt;</span></span>
   <span>?additional_messages:<span><a href="#type-message">message</a> list</span> <span class="arrow">&#45;&gt;</span></span>
@@ -37,4 +31,10 @@
   <span><a href="#type-severity">severity</a> <span class="arrow">&#45;&gt;</span></span>
   <span><span class="type-var">'code</span> <span class="arrow">&#45;&gt;</span></span>
   <span><span><span>(<span class="type-var">'a</span>, <span class="xref-unresolved">Stdlib</span>.Format.formatter, unit, <span class="type-var">'b</span>)</span> <span class="xref-unresolved">Stdlib</span>.format4</span> <span class="arrow">&#45;&gt;</span></span>
-  <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>kmakef kont severity code format ...</code> is <code>kont (makef severity code format ...)</code>.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">loc</span> <p>The location of the text (usually the code) to highlight.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">backtrace</span> <p>The backtrace (to overwrite the accumulative frames up to this point).</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">additional_messages</span> <p>Additional messages that part of the backtrace. For example, they can be bindings shadowed by the current one.</p></li></ul></div></div><h2 id="other-helper-functions"><a href="#other-helper-functions" class="anchor"></a>Other Helper Functions</h2><div class="odoc-spec"><div class="spec value anchored" id="val-string_of_severity"><a href="#val-string_of_severity" class="anchor"></a><code><span><span class="keyword">val</span> string_of_severity : <span><a href="#type-severity">severity</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div><div class="spec-doc"><p>A convenience function that converts a <a href="#type-severity"><code>severity</code></a> into its constructor name. For example, <a href="#type-severity.Warning"><code>Warning</code></a> will be converted into the string <code>&quot;Warning&quot;</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-string_of_text"><a href="#val-string_of_text" class="anchor"></a><code><span><span class="keyword">val</span> string_of_text : <span><a href="#type-text">text</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div><div class="spec-doc"><p>A convenience function that converts a <a href="#type-text"><code>text</code></a> into a string by formatting it with the maximum admissible margin. Note that the resulting string may contain newline characters and thus not suitable to .</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-map"><a href="#val-map" class="anchor"></a><code><span><span class="keyword">val</span> map : <span><span>(<span><span class="type-var">'code1</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'code2</span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span><span class="type-var">'code1</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'code2</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p>A convenience function that maps the message code. This is helpful when using <a href="../Logger/module-type-S/index.html#val-adopt"><code>Logger.S.adopt</code></a>.</p></div></div></div></body></html>
+  <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>kmakef kont severity code format ...</code> is <code>kont (makef severity code format ...)</code>.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">loc</span> <p>The location of the text (usually the code) to highlight.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">backtrace</span> <p>The backtrace (to overwrite the accumulative frames up to this point).</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">additional_messages</span> <p>Additional messages that part of the backtrace. For example, they can be bindings shadowed by the current one.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_message"><a href="#val-of_message" class="anchor"></a><code><span><span class="keyword">val</span> of_message : 
+  <span>?backtrace:<a href="#type-backtrace">backtrace</a> <span class="arrow">&#45;&gt;</span></span>
+  <span>?additional_messages:<span><a href="#type-message">message</a> list</span> <span class="arrow">&#45;&gt;</span></span>
+  <span><a href="#type-severity">severity</a> <span class="arrow">&#45;&gt;</span></span>
+  <span><span class="type-var">'code</span> <span class="arrow">&#45;&gt;</span></span>
+  <span><a href="#type-message">message</a> <span class="arrow">&#45;&gt;</span></span>
+  <span><span class="type-var">'code</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>of_message severity code message</code> constructs a diagnostic with the <code>message</code>.</p><p>Example:</p><pre class="language-ocaml"><code>make Warning `ChiError @@ message &quot;Your Ch'i is critically low&quot;</code></pre><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">backtrace</span> <p>The backtrace (to overwrite the accumulative frames up to this point).</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">additional_messages</span> <p>Additional messages that part of the backtrace. For example, they can be bindings shadowed by the current one.</p></li></ul></div></div><h2 id="other-helper-functions"><a href="#other-helper-functions" class="anchor"></a>Other Helper Functions</h2><div class="odoc-spec"><div class="spec value anchored" id="val-map"><a href="#val-map" class="anchor"></a><code><span><span class="keyword">val</span> map : <span><span>(<span><span class="type-var">'code1</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'code2</span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span><span class="type-var">'code1</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'code2</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p>A convenience function that maps the message code. This is helpful when using <a href="../Logger/module-type-S/index.html#val-adopt"><code>Logger.S.adopt</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-string_of_severity"><a href="#val-string_of_severity" class="anchor"></a><code><span><span class="keyword">val</span> string_of_severity : <span><a href="#type-severity">severity</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div><div class="spec-doc"><p>A convenience function that converts a <a href="#type-severity"><code>severity</code></a> into its constructor name. For example, <a href="#type-severity.Warning"><code>Warning</code></a> will be converted into the string <code>&quot;Warning&quot;</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-string_of_text"><a href="#val-string_of_text" class="anchor"></a><code><span><span class="keyword">val</span> string_of_text : <span><a href="#type-text">text</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div><div class="spec-doc"><p>A convenience function that converts a <a href="#type-text"><code>text</code></a> into a string by formatting it with the maximum admissible margin. Note that the resulting string may contain newline characters and thus not suitable to .</p></div></div></div></body></html>