-
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
8 changed files
with
142 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.</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-Message"><a href="#module-type-Message" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-Message/index.html">Message</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>The signature of messages. An implementer should specify the message type 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-Message/index.html">Message</a> : <a href="module-type-Message/index.html">Message</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/Message/index.html">Message</a> := <a href="Make/argument-1-Message/index.html">Message</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. The API is optimized for attaching free-form text.</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-Message"><a href="#module-type-Message" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-Message/index.html">Message</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>The signature of messages. An implementer should specify the message type 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-Message/index.html">Message</a> : <a href="module-type-Message/index.html">Message</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/Message/index.html">Message</a> := <a href="Make/argument-1-Message/index.html">Message</a></span></span></code></div><div class="spec-doc"><p>The functor to generate a logger.</p></div></div></div></body></html> |
2 changes: 2 additions & 0 deletions
2
asai/Asai/StructuredReporter/Make/argument-1-Message/index.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 |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Message (asai.Asai.StructuredReporter.Make.Message)</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> » <a href="../../index.html">StructuredReporter</a> » <a href="../index.html">Make</a> » Message</nav><header class="odoc-preamble"><h1>Parameter <code><span>Make.Message</span></code></h1></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> t</span></code></div><div class="spec-doc"><p>The type of all structured messages.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default_severity"><a href="#val-default_severity" class="anchor"></a><code><span><span class="keyword">val</span> default_severity : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../../../Diagnostic/index.html#type-severity">Diagnostic.severity</a></span></code></div><div class="spec-doc"><p>The default severity level of a message. Severity levels classify diagnostics into errors, warnings, etc. It is about how serious the <i>end user</i> should take the diagnostic, not whether the program should stop or continue. The severity may be overwritten at the time of issuing a diagnostic.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default_text"><a href="#val-default_text" class="anchor"></a><code><span><span class="keyword">val</span> default_text : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../../../Diagnostic/index.html#type-text">Diagnostic.text</a></span></code></div><div class="spec-doc"><p>The default text of the message. The text may be overwritten at the time of issuing a diagnostic to the end user.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-short_code"><a href="#val-short_code" class="anchor"></a><code><span><span class="keyword">val</span> short_code : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p>A concise, ideally Google-able string representation of each message. Detailed or long descriptions should be avoided---the shorter, the better. For example, <code>E001</code> works better than <code>type-checking error</code>. It will be assumed that the string representation has no control characters (such as newline characters).</p></div></div></div></body></html> |
Oops, something went wrong.