Skip to content

Commit

Permalink
Update bam doc to 0.3.
Browse files Browse the repository at this point in the history
  • Loading branch information
saroupille committed Oct 25, 2024
1 parent b2c5eee commit b9ab0d3
Show file tree
Hide file tree
Showing 21 changed files with 23 additions and 23 deletions.
2 changes: 1 addition & 1 deletion bam-ppx/Bam_ppx/index.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Bam_ppx (bam-ppx.Bam_ppx)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.3"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../index.html">bam-ppx</a> &#x00BB; Bam_ppx</nav><header class="odoc-preamble"><h1>Module <code><span>Bam_ppx</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-deriving_str_type_declaration"><a href="#val-deriving_str_type_declaration" class="anchor"></a><code><span><span class="keyword">val</span> deriving_str_type_declaration :
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Bam_ppx (bam-ppx.Bam_ppx)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../index.html">bam-ppx</a> &#x00BB; Bam_ppx</nav><header class="odoc-preamble"><h1>Module <code><span>Bam_ppx</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-deriving_str_type_declaration"><a href="#val-deriving_str_type_declaration" class="anchor"></a><code><span><span class="keyword">val</span> deriving_str_type_declaration :
<span><span class="label">ctxt</span>:<span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span>
<span><span>(<span class="xref-unresolved">Ppxlib</span>.Asttypes.rec_flag * <span><span class="xref-unresolved">Ppxlib</span>.type_declaration list</span>)</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="xref-unresolved">Ppxlib</span>.structure_item list</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-str_type_decl"><a href="#val-str_type_decl" class="anchor"></a><code><span><span class="keyword">val</span> str_type_decl :
Expand Down
2 changes: 1 addition & 1 deletion bam-ppx/index.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (bam-ppx.index)</title><meta charset="utf-8"/><link rel="stylesheet" href="../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.3"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – bam-ppx</nav><header class="odoc-preamble"><h1 id="bam-ppx-index"><a href="#bam-ppx-index" class="anchor"></a>bam-ppx index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-bam-ppx">Library bam-ppx</a></li></ul></nav><div class="odoc-content"><h2 id="library-bam-ppx"><a href="#library-bam-ppx" class="anchor"></a>Library bam-ppx</h2><p>The entry point of this library is the module: <a href="Bam_ppx/index.html"><code>Bam_ppx</code></a>.</p></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (bam-ppx.index)</title><meta charset="utf-8"/><link rel="stylesheet" href="../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – bam-ppx</nav><header class="odoc-preamble"><h1 id="bam-ppx-index"><a href="#bam-ppx-index" class="anchor"></a>bam-ppx index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-bam-ppx">Library bam-ppx</a></li></ul></nav><div class="odoc-content"><h2 id="library-bam-ppx"><a href="#library-bam-ppx" class="anchor"></a>Library bam-ppx</h2><p>The entry point of this library is the module: <a href="Bam_ppx/index.html"><code>Bam_ppx</code></a>.</p></div></body></html>
2 changes: 1 addition & 1 deletion bam/Bam/Gen/Merge/index.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Merge (bam.Bam.Gen.Merge)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.3"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../../../index.html">bam</a> &#x00BB; <a href="../../index.html">Bam</a> &#x00BB; <a href="../index.html">Gen</a> &#x00BB; Merge</nav><header class="odoc-preamble"><h1>Module <code><span>Gen.Merge</span></code></h1><p>The bind function needs to be able to merge nodes between two trees. This library allows you to override the default behaviour be defining your own merge function. The function <a href="../index.html#val-with_merge"><code>with_merge</code></a> aims to be used just before the next bind.</p><p>By default, <a href="../index.html#val-bind"><code>bind</code></a> uses the <a href="#val-default"><code>Merge.default</code></a> strategy. See <a href="../../Tree/index.html#val-with_merge"><code>Tree.with_merge</code></a> for an explanation of what merging is.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default"><a href="#val-default" class="anchor"></a><code><span><span class="keyword">val</span> default : <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>default</code> is the merging function used by <code>bind</code>. While using <code>bind gen f</code>, values of <code>gen</code> always preceeds the values produced by <code>f a</code> where <code>a</code> is either the value produced by the generator <code>gen</code> or during the shrinking.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-drop_left"><a href="#val-drop_left" class="anchor"></a><code><span><span class="keyword">val</span> drop_left : <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>drop_left</code> is the merging function that drops the values of <code>gen</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-drop_right"><a href="#val-drop_right" class="anchor"></a><code><span><span class="keyword">val</span> drop_right : <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>drop_left</code> is the merging function that drops the values produced by <code>f a</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_compare"><a href="#val-of_compare" class="anchor"></a><code><span><span class="keyword">val</span> of_compare : <span><span class="label">compare</span>:<span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> int)</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>drop_left</code> is the merging function that, with a <code>bind</code>, merges values of <code>gen</code> or <code>f a</code> according to <code>compare</code>.</p></div></div></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Merge (bam.Bam.Gen.Merge)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../../../index.html">bam</a> &#x00BB; <a href="../../index.html">Bam</a> &#x00BB; <a href="../index.html">Gen</a> &#x00BB; Merge</nav><header class="odoc-preamble"><h1>Module <code><span>Gen.Merge</span></code></h1><p>The bind function needs to be able to merge nodes between two trees. This library allows you to override the default behaviour be defining your own merge function. The function <a href="../index.html#val-with_merge"><code>with_merge</code></a> aims to be used just before the next bind.</p><p>By default, <a href="../index.html#val-bind"><code>bind</code></a> uses the <a href="#val-default"><code>Merge.default</code></a> strategy. See <a href="../../Tree/index.html#val-with_merge"><code>Tree.with_merge</code></a> for an explanation of what merging is.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default"><a href="#val-default" class="anchor"></a><code><span><span class="keyword">val</span> default : <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>default</code> is the merging function used by <code>bind</code>. While using <code>bind gen f</code>, values of <code>gen</code> always preceeds the values produced by <code>f a</code> where <code>a</code> is either the value produced by the generator <code>gen</code> or during the shrinking.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-drop_left"><a href="#val-drop_left" class="anchor"></a><code><span><span class="keyword">val</span> drop_left : <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>drop_left</code> is the merging function that drops the values of <code>gen</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-drop_right"><a href="#val-drop_right" class="anchor"></a><code><span><span class="keyword">val</span> drop_right : <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>drop_left</code> is the merging function that drops the values produced by <code>f a</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_compare"><a href="#val-of_compare" class="anchor"></a><code><span><span class="keyword">val</span> of_compare : <span><span class="label">compare</span>:<span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> int)</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>drop_left</code> is the merging function that, with a <code>bind</code>, merges values of <code>gen</code> or <code>f a</code> according to <code>compare</code>.</p></div></div></div></body></html>
2 changes: 1 addition & 1 deletion bam/Bam/Gen/Syntax/index.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Syntax (bam.Bam.Gen.Syntax)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.3"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../../../index.html">bam</a> &#x00BB; <a href="../../index.html">Bam</a> &#x00BB; <a href="../index.html">Gen</a> &#x00BB; Syntax</nav><header class="odoc-preamble"><h1>Module <code><span>Gen.Syntax</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-let*"><a href="#val-let*" class="anchor"></a><code><span><span class="keyword">val</span> let* : <span><span><span class="type-var">'a</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="../index.html#type-t">t</a></span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p>Alias for <a href="../index.html#val-bind"><code>bind</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-let*!"><a href="#val-let*!" class="anchor"></a><code><span><span class="keyword">val</span> let*! : <span><span><span class="type-var">'a</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="../index.html#type-t">t</a></span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p>Alias for <a href="../index.html#val-root"><code>root</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-return"><a href="#val-return" class="anchor"></a><code><span><span class="keyword">val</span> return : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p>Alias for <a href="#val-return"><code>return</code></a>.</p></div></div></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Syntax (bam.Bam.Gen.Syntax)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../../../index.html">bam</a> &#x00BB; <a href="../../index.html">Bam</a> &#x00BB; <a href="../index.html">Gen</a> &#x00BB; Syntax</nav><header class="odoc-preamble"><h1>Module <code><span>Gen.Syntax</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-let*"><a href="#val-let*" class="anchor"></a><code><span><span class="keyword">val</span> let* : <span><span><span class="type-var">'a</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="../index.html#type-t">t</a></span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p>Alias for <a href="../index.html#val-bind"><code>bind</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-let*!"><a href="#val-let*!" class="anchor"></a><code><span><span class="keyword">val</span> let*! : <span><span><span class="type-var">'a</span> <a href="../index.html#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="../index.html#type-t">t</a></span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p>Alias for <a href="../index.html#val-root"><code>root</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-return"><a href="#val-return" class="anchor"></a><code><span><span class="keyword">val</span> return : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p>Alias for <a href="#val-return"><code>return</code></a>.</p></div></div></div></body></html>
Loading

0 comments on commit b9ab0d3

Please sign in to comment.