Skip to content

Commit

Permalink
Update provider doc to 0.0.3.
Browse files Browse the repository at this point in the history
  • Loading branch information
mbarbin committed Feb 21, 2024
1 parent 2c0a938 commit bde1cda
Show file tree
Hide file tree
Showing 19 changed files with 39 additions and 37 deletions.
4 changes: 2 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
<div class="by-name">
<h2>OCaml package documentation</h2>
<ol>
<li><a href="provider/index.html">provider</a> <span class="version">0.0.2</span></li>
<li><a href="provider-test/index.html">provider-test</a> <span class="version">0.0.2</span></li>
<li><a href="provider/index.html">provider</a> <span class="version">0.0.3</span></li>
<li><a href="provider-test/index.html">provider-test</a> <span class="version">0.0.3</span></li>
</ol>
</div>
</main>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Provider_interface (provider-test.Provider_test.Interface.Directory_reader.Provider_interface)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script><script>let base_url = '../../../../../';
let search_urls = ['../../../../db.js','../../../../../sherlodoc.js'];
</script><script src="../../../../../odoc.support/odoc_search.js" defer="defer"></script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../../../../index.html">provider-test</a> &#x00BB; <a href="../../../index.html">Provider_test</a> &#x00BB; <a href="../../index.html">Interface</a> &#x00BB; <a href="../index.html">Directory_reader</a> &#x00BB; Provider_interface</nav><div class="odoc-search"><div class="search-inner"><input class="search-bar" placeholder="🔎 Search..."/><div class="search-snake"></div><div class="search-result"></div></div></div><header class="odoc-preamble"><h1>Module <code><span>Directory_reader.Provider_interface</span></code></h1><p>Such abstraction will export a way for implementers (providers) to provide an implementation for that interface. In <code>Eio</code> naming conventions, these modules are typically named <code>Pi</code>.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></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><span>(<span class="keyword">module</span> <a href="module-type-S/index.html">S</a> <span class="keyword">with</span> <span class="keyword">type</span> <a href="module-type-S/index.html#type-t">t</a> = <span class="type-var">'t</span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span class="type-var">'t</span>, <a href="../index.html#type-tag">tag</a>)</span> <a href="../../../../../provider/Provider/Interface/index.html#type-t">Provider.Interface.t</a></span></span></code></div><div class="spec-doc"><p><code>make (module Impl)</code> creates a provider interface that implements the directory_reader functionality. Another option is to use the constructor <code>Directory_reader</code> below.</p></div></div><div class="odoc-spec"><div class="spec type extension anchored" id="extension-decl-Directory_reader"><a href="#extension-decl-Directory_reader" class="anchor"></a><code><span><span class="keyword">type</span> <a href="../../../../../provider/Provider/Class_id/index.html#type-t">Provider.Class_id.t</a> += </span></code><ol><li id="extension-Directory_reader" class="def variant extension anchored"><a href="#extension-Directory_reader" class="anchor"></a><code><span>| </span><span><span class="extension">Directory_reader</span> : <span><span>(<span class="type-var">'t</span>, <span>(<span class="keyword">module</span> <a href="module-type-S/index.html">S</a> <span class="keyword">with</span> <span class="keyword">type</span> <a href="module-type-S/index.html#type-t">t</a> = <span class="type-var">'t</span>)</span>, <span>[&gt; <a href="../index.html#type-tag">tag</a> ]</span>)</span>
<a href="../../../../../provider/Provider/Class_id/index.html#type-t">Provider.Class_id.t</a></span></span></code></li></ol></div><div class="spec-doc"><p>The actual class id may or may not be exported by the provider interface - either way works. That's left as a programmer's preference depending on the context. When this constructor is exported, you can use it in conjunction with <a href="../../../../../provider/Provider/Class/index.html#val-implement"><code>Provider.Class.implement</code></a>.</p></div></div></div></body></html>
</script><script src="../../../../../odoc.support/odoc_search.js" defer="defer"></script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../../../../index.html">provider-test</a> &#x00BB; <a href="../../../index.html">Provider_test</a> &#x00BB; <a href="../../index.html">Interface</a> &#x00BB; <a href="../index.html">Directory_reader</a> &#x00BB; Provider_interface</nav><div class="odoc-search"><div class="search-inner"><input class="search-bar" placeholder="🔎 Search..."/><div class="search-snake"></div><div class="search-result"></div></div></div><header class="odoc-preamble"><h1>Module <code><span>Directory_reader.Provider_interface</span></code></h1><p>Such abstraction will export a way for implementers (providers) to provide an implementation for that interface. In <code>Eio</code> naming conventions, these modules are typically named <code>Pi</code>.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></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><span>(<span class="keyword">module</span> <a href="module-type-S/index.html">S</a> <span class="keyword">with</span> <span class="keyword">type</span> <a href="module-type-S/index.html#type-t">t</a> = <span class="type-var">'t</span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span class="type-var">'t</span>, <a href="../index.html#type-tag">tag</a>)</span> <a href="../../../../../provider/Provider/Interface/index.html#type-t">Provider.Interface.t</a></span></span></code></div><div class="spec-doc"><p><code>make (module Impl)</code> creates a provider interface that implements the directory_reader functionality. Another option is to use the constructor <code>Directory_reader</code> below.</p></div></div><div class="odoc-spec"><div class="spec type extension anchored" id="extension-decl-Directory_reader"><a href="#extension-decl-Directory_reader" class="anchor"></a><code><span><span class="keyword">type</span> <a href="../../../../../provider/Provider/Trait/index.html#type-t">Provider.Trait.t</a> += </span></code><ol><li id="extension-Directory_reader" class="def variant extension anchored"><a href="#extension-Directory_reader" class="anchor"></a><code><span>| </span><span><span class="extension">Directory_reader</span> : <span><span>(<span class="type-var">'t</span>, <span>(<span class="keyword">module</span> <a href="module-type-S/index.html">S</a> <span class="keyword">with</span> <span class="keyword">type</span> <a href="module-type-S/index.html#type-t">t</a> = <span class="type-var">'t</span>)</span>, <span>[&gt; <a href="../index.html#type-tag">tag</a> ]</span>)</span> <a href="../../../../../provider/Provider/Trait/index.html#type-t">Provider.Trait.t</a></span></span></code></li></ol></div><div class="spec-doc"><p>The actual trait constructor may or may not be exported by the provider interface -- either way works. That's left as a programmer's preference depending on the context. When this constructor is exported, you can use it in conjunction with <a href="../../../../../provider/Provider/Trait/index.html#val-implement"><code>Provider.Trait.implement</code></a>.</p></div></div></div></body></html>
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Provider_interface (provider-test.Provider_test.Interface.File_reader.Provider_interface)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script><script>let base_url = '../../../../../';
let search_urls = ['../../../../db.js','../../../../../sherlodoc.js'];
</script><script src="../../../../../odoc.support/odoc_search.js" defer="defer"></script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../../../../index.html">provider-test</a> &#x00BB; <a href="../../../index.html">Provider_test</a> &#x00BB; <a href="../../index.html">Interface</a> &#x00BB; <a href="../index.html">File_reader</a> &#x00BB; Provider_interface</nav><div class="odoc-search"><div class="search-inner"><input class="search-bar" placeholder="🔎 Search..."/><div class="search-snake"></div><div class="search-result"></div></div></div><header class="odoc-preamble"><h1>Module <code><span>File_reader.Provider_interface</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec type extension anchored" id="extension-decl-File_reader"><a href="#extension-decl-File_reader" class="anchor"></a><code><span><span class="keyword">type</span> <a href="../../../../../provider/Provider/Class_id/index.html#type-t">Provider.Class_id.t</a> += </span></code><ol><li id="extension-File_reader" class="def variant extension anchored"><a href="#extension-File_reader" class="anchor"></a><code><span>| </span><span><span class="extension">File_reader</span> : <span><span>(<span class="type-var">'t</span>, <span>(<span class="keyword">module</span> <a href="module-type-S/index.html">S</a> <span class="keyword">with</span> <span class="keyword">type</span> <a href="module-type-S/index.html#type-t">t</a> = <span class="type-var">'t</span>)</span>, <span>[&gt; <a href="../index.html#type-tag">tag</a> ]</span>)</span> <a href="../../../../../provider/Provider/Class_id/index.html#type-t">Provider.Class_id.t</a></span></span></code></li></ol></div></div></div></body></html>
</script><script src="../../../../../odoc.support/odoc_search.js" defer="defer"></script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../../../../index.html">provider-test</a> &#x00BB; <a href="../../../index.html">Provider_test</a> &#x00BB; <a href="../../index.html">Interface</a> &#x00BB; <a href="../index.html">File_reader</a> &#x00BB; Provider_interface</nav><div class="odoc-search"><div class="search-inner"><input class="search-bar" placeholder="🔎 Search..."/><div class="search-snake"></div><div class="search-result"></div></div></div><header class="odoc-preamble"><h1>Module <code><span>File_reader.Provider_interface</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec type extension anchored" id="extension-decl-File_reader"><a href="#extension-decl-File_reader" class="anchor"></a><code><span><span class="keyword">type</span> <a href="../../../../../provider/Provider/Trait/index.html#type-t">Provider.Trait.t</a> += </span></code><ol><li id="extension-File_reader" class="def variant extension anchored"><a href="#extension-File_reader" class="anchor"></a><code><span>| </span><span><span class="extension">File_reader</span> : <span><span>(<span class="type-var">'t</span>, <span>(<span class="keyword">module</span> <a href="module-type-S/index.html">S</a> <span class="keyword">with</span> <span class="keyword">type</span> <a href="module-type-S/index.html#type-t">t</a> = <span class="type-var">'t</span>)</span>, <span>[&gt; <a href="../index.html#type-tag">tag</a> ]</span>)</span> <a href="../../../../../provider/Provider/Trait/index.html#type-t">Provider.Trait.t</a></span></span></code></li></ol></div></div></div></body></html>
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Provider_interface (provider-test.Provider_test.Interface.Float_printer.Provider_interface)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script><script>let base_url = '../../../../../';
let search_urls = ['../../../../db.js','../../../../../sherlodoc.js'];
</script><script src="../../../../../odoc.support/odoc_search.js" defer="defer"></script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../../../../index.html">provider-test</a> &#x00BB; <a href="../../../index.html">Provider_test</a> &#x00BB; <a href="../../index.html">Interface</a> &#x00BB; <a href="../index.html">Float_printer</a> &#x00BB; Provider_interface</nav><div class="odoc-search"><div class="search-inner"><input class="search-bar" placeholder="🔎 Search..."/><div class="search-snake"></div><div class="search-result"></div></div></div><header class="odoc-preamble"><h1>Module <code><span>Float_printer.Provider_interface</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></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><span>(<span class="keyword">module</span> <a href="module-type-S/index.html">S</a> <span class="keyword">with</span> <span class="keyword">type</span> <a href="module-type-S/index.html#type-t">t</a> = <span class="type-var">'t</span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span class="type-var">'t</span>, <a href="../index.html#type-tag">tag</a>)</span> <a href="../../../../../provider/Provider/Interface/index.html#type-t">Provider.Interface.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec type extension anchored" id="extension-decl-Float_printer"><a href="#extension-decl-Float_printer" class="anchor"></a><code><span><span class="keyword">type</span> <a href="../../../../../provider/Provider/Class_id/index.html#type-t">Provider.Class_id.t</a> += </span></code><ol><li id="extension-Float_printer" class="def variant extension anchored"><a href="#extension-Float_printer" class="anchor"></a><code><span>| </span><span><span class="extension">Float_printer</span> : <span><span>(<span class="type-var">'t</span>, <span>(<span class="keyword">module</span> <a href="module-type-S/index.html">S</a> <span class="keyword">with</span> <span class="keyword">type</span> <a href="module-type-S/index.html#type-t">t</a> = <span class="type-var">'t</span>)</span>, <span>[&gt; <a href="../index.html#type-tag">tag</a> ]</span>)</span> <a href="../../../../../provider/Provider/Class_id/index.html#type-t">Provider.Class_id.t</a></span></span></code></li></ol></div></div></div></body></html>
</script><script src="../../../../../odoc.support/odoc_search.js" defer="defer"></script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../../../../index.html">provider-test</a> &#x00BB; <a href="../../../index.html">Provider_test</a> &#x00BB; <a href="../../index.html">Interface</a> &#x00BB; <a href="../index.html">Float_printer</a> &#x00BB; Provider_interface</nav><div class="odoc-search"><div class="search-inner"><input class="search-bar" placeholder="🔎 Search..."/><div class="search-snake"></div><div class="search-result"></div></div></div><header class="odoc-preamble"><h1>Module <code><span>Float_printer.Provider_interface</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></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><span>(<span class="keyword">module</span> <a href="module-type-S/index.html">S</a> <span class="keyword">with</span> <span class="keyword">type</span> <a href="module-type-S/index.html#type-t">t</a> = <span class="type-var">'t</span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span class="type-var">'t</span>, <a href="../index.html#type-tag">tag</a>)</span> <a href="../../../../../provider/Provider/Interface/index.html#type-t">Provider.Interface.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec type extension anchored" id="extension-decl-Float_printer"><a href="#extension-decl-Float_printer" class="anchor"></a><code><span><span class="keyword">type</span> <a href="../../../../../provider/Provider/Trait/index.html#type-t">Provider.Trait.t</a> += </span></code><ol><li id="extension-Float_printer" class="def variant extension anchored"><a href="#extension-Float_printer" class="anchor"></a><code><span>| </span><span><span class="extension">Float_printer</span> : <span><span>(<span class="type-var">'t</span>, <span>(<span class="keyword">module</span> <a href="module-type-S/index.html">S</a> <span class="keyword">with</span> <span class="keyword">type</span> <a href="module-type-S/index.html#type-t">t</a> = <span class="type-var">'t</span>)</span>, <span>[&gt; <a href="../index.html#type-tag">tag</a> ]</span>)</span> <a href="../../../../../provider/Provider/Trait/index.html#type-t">Provider.Trait.t</a></span></span></code></li></ol></div></div></div></body></html>
Loading

0 comments on commit bde1cda

Please sign in to comment.