-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
2 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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>Reporter (asai.Asai.Reporter)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc v2.3.0"/><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">asai</a> » <a href="../index.html">Asai</a> » Reporter</nav><header class="odoc-preamble"><h1>Module <code><span>Asai.Reporter</span></code></h1><p>Generating and handling diagnostics using algebraic effects. The API is optimized for unstructured messages.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.2.0 (renamed from Logger)</li></ul></header><div class="odoc-content"><div class="spec-doc"><p>The signature of a reporter.</p></div><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-Code"><a href="#module-type-Code" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-Code/index.html">Code</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>The signature of message code. An implementer should specify the message code used in their library or application.</p></div></div><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 module anchored" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Make/index.html">Make</a></span><span> (<a href="Make/argument-1-Code/index.html">Code</a> : <a href="module-type-Code/index.html">Code</a>) : <a href="module-type-S/index.html">S</a> <span class="keyword">with</span> <span><span class="keyword">module</span> <a href="module-type-S/Code/index.html">Code</a> := <a href="Make/argument-1-Code/index.html">Code</a></span></span></code></div><div class="spec-doc"><p>The functor to generate a logger.</p></div></div></div></body></html> | ||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Reporter (asai.Asai.Reporter)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc v2.3.0"/><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">asai</a> » <a href="../index.html">Asai</a> » Reporter</nav><header class="odoc-preamble"><h1>Module <code><span>Asai.Reporter</span></code></h1><p>Generating and handling diagnostics using algebraic effects.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.2.0 (renamed from Logger)</li></ul></header><div class="odoc-content"><div class="spec-doc"><p>The signature of a reporter.</p></div><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-Code"><a href="#module-type-Code" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-Code/index.html">Code</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>The signature of message code. An implementer should specify the message code used in their library or application.</p></div></div><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 module anchored" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Make/index.html">Make</a></span><span> (<a href="Make/argument-1-Code/index.html">Code</a> : <a href="module-type-Code/index.html">Code</a>) : <a href="module-type-S/index.html">S</a> <span class="keyword">with</span> <span><span class="keyword">module</span> <a href="module-type-S/Code/index.html">Code</a> := <a href="Make/argument-1-Code/index.html">Code</a></span></span></code></div><div class="spec-doc"><p>The functor to generate a logger.</p></div></div></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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>Asai (asai.Asai)</title><link rel="stylesheet" href="../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc v2.3.0"/><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">asai</a> » Asai</nav><header class="odoc-preamble"><h1>Module <code><span>Asai</span></code></h1><p>Compiler diagnostics</p></header><nav class="odoc-toc"><ul><li><a href="#core-api">Core API</a></li><li><a href="#experimental-diagnostic-handlers">Experimental Diagnostic Handlers</a></li><li><a href="#internals">Internals</a></li></ul></nav><div class="odoc-content"><p>A diagnostic is a message for the end user, for example a compiler warning or error.</p><h2 id="core-api"><a href="#core-api" class="anchor"></a>Core API</h2><div class="odoc-spec"><div class="spec module anchored" id="module-Span"><a href="#module-Span" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Span/index.html">Span</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Locations and spans.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Diagnostic"><a href="#module-Diagnostic" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Diagnostic/index.html">Diagnostic</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>The definition of diagnostics and some utility functions.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Reporter"><a href="#module-Reporter" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Reporter/index.html">Reporter</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Generating and handling diagnostics using algebraic effects. The API is optimized for unstructured messages.</p></div></div><h2 id="experimental-diagnostic-handlers"><a href="#experimental-diagnostic-handlers" class="anchor"></a>Experimental Diagnostic Handlers</h2><div class="odoc-spec"><div class="spec module anchored" id="module-Tty"><a href="#module-Tty" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Tty/index.html">Tty</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Diagnostic display for UNIX terminals.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Lsp"><a href="#module-Lsp" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Lsp/index.html">Lsp</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>An LSP (Language Service Protocol) server for asai</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-GitHub"><a href="#module-GitHub" class="anchor"></a><code><span><span class="keyword">module</span> <a href="GitHub/index.html">GitHub</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>GitHub Actions workflow commands.</p></div></div><h2 id="internals"><a href="#internals" class="anchor"></a>Internals</h2><div class="odoc-spec"><div class="spec module anchored" id="module-Explication"><a href="#module-Explication" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Explication/index.html">Explication</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>The definition of highlighted text suitable for rendering. You probably do not need this module unless you want to create your own diagnostic handler.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Explicator"><a href="#module-Explicator" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Explicator/index.html">Explicator</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Turning location information into highlighted text suitable for rendering. You probably do not need this module unless you want to create your own diagnostic handler.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-SourceReader"><a href="#module-SourceReader" class="anchor"></a><code><span><span class="keyword">module</span> <a href="SourceReader/index.html">SourceReader</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Reading the source content. It uses memory-mapped I/O for files. You probably do not need this module unless you want to create your own diagnostic handler.</p></div></div></div></body></html> | ||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Asai (asai.Asai)</title><link rel="stylesheet" href="../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc v2.3.0"/><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">asai</a> » Asai</nav><header class="odoc-preamble"><h1>Module <code><span>Asai</span></code></h1><p>Compiler diagnostics</p></header><nav class="odoc-toc"><ul><li><a href="#core-api">Core API</a></li><li><a href="#experimental-diagnostic-handlers">Experimental Diagnostic Handlers</a></li><li><a href="#internals">Internals</a></li></ul></nav><div class="odoc-content"><p>A diagnostic is a message for the end user, for example a compiler warning or error.</p><h2 id="core-api"><a href="#core-api" class="anchor"></a>Core API</h2><div class="odoc-spec"><div class="spec module anchored" id="module-Span"><a href="#module-Span" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Span/index.html">Span</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Locations and spans.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Diagnostic"><a href="#module-Diagnostic" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Diagnostic/index.html">Diagnostic</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>The definition of diagnostics and some utility functions.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Reporter"><a href="#module-Reporter" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Reporter/index.html">Reporter</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Generating and handling diagnostics using algebraic effects.</p></div></div><h2 id="experimental-diagnostic-handlers"><a href="#experimental-diagnostic-handlers" class="anchor"></a>Experimental Diagnostic Handlers</h2><div class="odoc-spec"><div class="spec module anchored" id="module-Tty"><a href="#module-Tty" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Tty/index.html">Tty</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Diagnostic display for UNIX terminals.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Lsp"><a href="#module-Lsp" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Lsp/index.html">Lsp</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>An LSP (Language Service Protocol) server for asai</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-GitHub"><a href="#module-GitHub" class="anchor"></a><code><span><span class="keyword">module</span> <a href="GitHub/index.html">GitHub</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>GitHub Actions workflow commands.</p></div></div><h2 id="internals"><a href="#internals" class="anchor"></a>Internals</h2><div class="odoc-spec"><div class="spec module anchored" id="module-Explication"><a href="#module-Explication" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Explication/index.html">Explication</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>The definition of highlighted text suitable for rendering. You probably do not need this module unless you want to create your own diagnostic handler.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Explicator"><a href="#module-Explicator" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Explicator/index.html">Explicator</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Turning location information into highlighted text suitable for rendering. You probably do not need this module unless you want to create your own diagnostic handler.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-SourceReader"><a href="#module-SourceReader" class="anchor"></a><code><span><span class="keyword">module</span> <a href="SourceReader/index.html">SourceReader</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Reading the source content. It uses memory-mapped I/O for files. You probably do not need this module unless you want to create your own diagnostic handler.</p></div></div></div></body></html> |