Skip to content

Commit

Permalink
Update generated API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@lukstafi
lukstafi committed Dec 22, 2023
1 parent 17355ca commit ced56db
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/_html/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<div class="by-name">
<h2>OCaml package documentation</h2>
<ol>
<li><a href="ppx_minidebug/index.html">ppx_minidebug</a> <span class="version">0.6.2</span></li>
<li><a href="ppx_minidebug/index.html">ppx_minidebug</a> <span class="version">0.7.0</span></li>
</ol>
</div>
</main>
Expand Down
2 changes: 1 addition & 1 deletion docs/_html/ppx_minidebug/Minidebug_runtime/PrintBox/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@
<span><span class="label">descr</span>:string <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">pp</span>:<span>(<span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> unit)</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">v</span>:<span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-log_value_show"><a href="#val-log_value_show" class="anchor"></a><code><span><span class="keyword">val</span> log_value_show : <span><span class="label">descr</span>:string <span class="arrow">&#45;&gt;</span></span> <span><span class="label">v</span>:string <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-exceeds_max_nesting"><a href="#val-exceeds_max_nesting" class="anchor"></a><code><span><span class="keyword">val</span> exceeds_max_nesting : <span>unit <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-exceeds_max_children"><a href="#val-exceeds_max_children" class="anchor"></a><code><span><span class="keyword">val</span> exceeds_max_children : <span>unit <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div></details></div><div class="odoc-spec"><div class="spec value anchored" id="val-no_debug_if"><a href="#val-no_debug_if" class="anchor"></a><code><span><span class="keyword">val</span> no_debug_if : <span>bool <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>When passed true within the scope of a log subtree, disables the logging of this subtree and its subtrees. Does not do anything when passed false (<code>no_debug_if false</code> does <em>not</em> re-enable the log).</p></div></div></details></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_html"><a href="#val-to_html" class="anchor"></a><code><span><span class="keyword">val</span> to_html : <span>bool <span class="xref-unresolved">Stdlib</span>.ref</span></span></code></div><div class="spec-doc"><p>While <code>true</code>, logs are generated as html; if <code>false</code>, as monospaced text.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-boxify_sexp_from_size"><a href="#val-boxify_sexp_from_size" class="anchor"></a><code><span><span class="keyword">val</span> boxify_sexp_from_size : <span>int <span class="xref-unresolved">Stdlib</span>.ref</span></span></code></div><div class="spec-doc"><p>If positive, <code>Sexp.t</code>-based logs with this many or more atoms are converted to print-boxes before logging.</p></div></div></div></body></html>
unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-log_value_show"><a href="#val-log_value_show" class="anchor"></a><code><span><span class="keyword">val</span> log_value_show : <span><span class="label">descr</span>:string <span class="arrow">&#45;&gt;</span></span> <span><span class="label">v</span>:string <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-exceeds_max_nesting"><a href="#val-exceeds_max_nesting" class="anchor"></a><code><span><span class="keyword">val</span> exceeds_max_nesting : <span>unit <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-exceeds_max_children"><a href="#val-exceeds_max_children" class="anchor"></a><code><span><span class="keyword">val</span> exceeds_max_children : <span>unit <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div></details></div><div class="odoc-spec"><div class="spec value anchored" id="val-no_debug_if"><a href="#val-no_debug_if" class="anchor"></a><code><span><span class="keyword">val</span> no_debug_if : <span>bool <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>When passed true within the scope of a log subtree, disables the logging of this subtree and its subtrees. Does not do anything when passed false (<code>no_debug_if false</code> does <em>not</em> re-enable the log).</p></div></div></details></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_html"><a href="#val-to_html" class="anchor"></a><code><span><span class="keyword">val</span> to_html : <span>bool <span class="xref-unresolved">Stdlib</span>.ref</span></span></code></div><div class="spec-doc"><p>While <code>true</code>, logs are generated as html; if <code>false</code>, as monospaced text.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-boxify_sexp_from_size"><a href="#val-boxify_sexp_from_size" class="anchor"></a><code><span><span class="keyword">val</span> boxify_sexp_from_size : <span>int <span class="xref-unresolved">Stdlib</span>.ref</span></span></code></div><div class="spec-doc"><p>If positive, <code>Sexp.t</code>-based logs with this many or more atoms are converted to print-boxes before logging.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-highlight_terms"><a href="#val-highlight_terms" class="anchor"></a><code><span><span class="keyword">val</span> highlight_terms : <span><span><span class="xref-unresolved">Re</span>.re option</span> <span class="xref-unresolved">Stdlib</span>.ref</span></span></code></div><div class="spec-doc"><p>Uses a highlight style for logs on paths ending with a log matching the regular expression.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-exclude_on_path"><a href="#val-exclude_on_path" class="anchor"></a><code><span><span class="keyword">val</span> exclude_on_path : <span><span><span class="xref-unresolved">Re</span>.re option</span> <span class="xref-unresolved">Stdlib</span>.ref</span></span></code></div><div class="spec-doc"><p>Does not propagate the highlight status from child logs through log headers matching the given regular expression.</p></div></div></div></body></html>
4 changes: 4 additions & 0 deletions docs/_html/ppx_minidebug/Minidebug_runtime/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
<span><span class="optlabel">?time_tagged</span>:bool <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?max_nesting_depth</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?max_num_children</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?highlight_terms</span>:<span class="xref-unresolved">Re</span>.t <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?exclude_on_path</span>:<span class="xref-unresolved">Re</span>.t <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?for_append</span>:bool <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?boxify_sexp_from_size</span>:int <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span>
Expand All @@ -17,6 +19,8 @@
<span><span class="optlabel">?time_tagged</span>:bool <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?max_nesting_depth</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?max_num_children</span>:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?highlight_terms</span>:<span class="xref-unresolved">Re</span>.t <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?exclude_on_path</span>:<span class="xref-unresolved">Re</span>.t <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>
<span>(<span class="keyword">module</span> <a href="module-type-Debug_runtime_cond/index.html">Debug_runtime_cond</a>)</span></span></code></div><div class="spec-doc"><p>Creates a PrintBox-based debug runtime. By default it will log to <code>stdout</code> and will not be time tagged.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-debug_flushing"><a href="#val-debug_flushing" class="anchor"></a><code><span><span class="keyword">val</span> debug_flushing :
<span><span class="optlabel">?debug_ch</span>:<span class="xref-unresolved">Stdlib</span>.out_channel <span class="arrow">&#45;&gt;</span></span>
Expand Down
Loading

0 comments on commit ced56db

Please sign in to comment.