-
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
12 changed files
with
12 additions
and
12 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
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>Code (asai.Asai.Diagnostic.Code)</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">Diagnostic</a> » Code</nav><header class="odoc-preamble"><h1>Module type <code><span>Diagnostic.Code</span></code></h1><p>The signature of message code. An implementer should specify the message code used in their library or application.</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> t</span></code></div><div class="spec-doc"><p>The type of all message codes.</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="../index.html#type-severity">severity</a></span></code></div><div class="spec-doc"><p>The default severity of the code. The severity of a message is about whether the message is an error or a warning, etc. To clarify, it is about how serious the message is to the <i>end user,</i> not whether the program should stop or continue. The severity may be overwritten at the time of issuing a message to the end user.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_string"><a href="#val-to_string" class="anchor"></a><code><span><span class="keyword">val</span> to_string : <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 code. Detailed or long descriptions of code should be avoided. For example, <code>E001</code> works better than <code>type-checking error</code>. The shorter, the better. It will be assumed that the string representation only uses ASCII printable characters.</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>Make (asai.Asai.GitHub.Make)</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">GitHub</a> » Make</nav><header class="odoc-preamble"><h1>Module <code><span>GitHub.Make</span></code></h1><p>The functor to create a printer for GitHub Actions workflow commands.</p></header><nav class="odoc-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><div class="odoc-spec"><div class="spec parameter anchored" id="argument-1-Code"><a href="#argument-1-Code" class="anchor"></a><code><span><span class="keyword">module</span> </span><span><a href="argument-1-Code/index.html">Code</a></span><span> : <a href="../../Reporter/module-type-Code/index.html">Reporter.Code</a></span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><div class="odoc-spec"><div class="spec value anchored" id="val-print"><a href="#val-print" class="anchor"></a><code><span><span class="keyword">val</span> print : <span><span><a href="argument-1-Code/index.html#type-t">Code.t</a> <a href="../../Diagnostic/index.html#type-t">Diagnostic.t</a></span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Print a diagnostic as a GitHub Actions workflow command. Only the main message will be printed; backtraces and additional messages are ignored.</p><p>Example output:</p><pre>::error file=examples/stlc/example.lambda,line=2,endLine=2,title=E002::Variable 'x' is not in scope</pre><ul class="at-tags"><li class="see"><span class="at-tag">see</span> <a href="https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions" class="value">https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions</a> </li></ul></div></div></div></body></html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (asai.Asai.GitHub.Make)</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">GitHub</a> » Make</nav><header class="odoc-preamble"><h1>Module <code><span>GitHub.Make</span></code></h1><p>The functor to create a printer for GitHub Actions workflow commands.</p></header><nav class="odoc-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><div class="odoc-spec"><div class="spec parameter anchored" id="argument-1-Code"><a href="#argument-1-Code" class="anchor"></a><code><span><span class="keyword">module</span> </span><span><a href="argument-1-Code/index.html">Code</a></span><span> : <a href="../../Diagnostic/module-type-Code/index.html">Diagnostic.Code</a></span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><div class="odoc-spec"><div class="spec value anchored" id="val-print"><a href="#val-print" class="anchor"></a><code><span><span class="keyword">val</span> print : <span><span><a href="argument-1-Code/index.html#type-t">Code.t</a> <a href="../../Diagnostic/index.html#type-t">Diagnostic.t</a></span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Print a diagnostic as a GitHub Actions workflow command. Only the main message will be printed; backtraces and additional messages are ignored.</p><p>Example output:</p><pre>::error file=examples/stlc/example.lambda,line=2,endLine=2,title=E002::Variable 'x' is not in scope</pre><ul class="at-tags"><li class="see"><span class="at-tag">see</span> <a href="https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions" class="value">https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions</a> </li></ul></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>GitHub (asai.Asai.GitHub)</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> » GitHub</nav><header class="odoc-preamble"><h1>Module <code><span>Asai.GitHub</span></code></h1><p>GitHub Actions workflow commands.</p><ul class="at-tags"><li class="see"><span class="at-tag">see</span> <a href="https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions" class="value">https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions</a> </li></ul><ul class="at-tags"><li class="alert"><span class="at-tag">alert</span> unstable The GitHub Actions backend will likely change significantly in the future to account for more features.</li></ul></header><div class="odoc-content"><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="../Reporter/module-type-Code/index.html">Reporter.Code</a>) : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>The functor to create a printer for GitHub Actions workflow commands.</p></div></div></div></body></html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>GitHub (asai.Asai.GitHub)</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> » GitHub</nav><header class="odoc-preamble"><h1>Module <code><span>Asai.GitHub</span></code></h1><p>GitHub Actions workflow commands.</p><ul class="at-tags"><li class="see"><span class="at-tag">see</span> <a href="https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions" class="value">https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions</a> </li></ul><ul class="at-tags"><li class="alert"><span class="at-tag">alert</span> unstable The GitHub Actions backend will likely change significantly in the future to account for more features.</li></ul></header><div class="odoc-content"><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="../Diagnostic/module-type-Code/index.html">Diagnostic.Code</a>) : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>The functor to create a printer for GitHub Actions workflow commands.</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
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>Lsp (asai.Asai.Lsp)</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> » Lsp</nav><header class="odoc-preamble"><h1>Module <code><span>Asai.Lsp</span></code></h1><p>An LSP (Language Service Protocol) server for asai</p><ul class="at-tags"><li class="alert"><span class="at-tag">alert</span> unstable The LSP backend may change significantly in the future.</li></ul></header><nav class="odoc-toc"><ul><li><a href="#language-service-protocol">Language Service Protocol</a></li></ul></nav><div class="odoc-content"><h2 id="language-service-protocol"><a href="#language-service-protocol" class="anchor"></a>Language Service Protocol</h2><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="../Reporter/module-type-Code/index.html">Reporter.Code</a>) : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>This module provides a rudimentary and incomplete implementation of the LSP protocol.</p></div></div></div></body></html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Lsp (asai.Asai.Lsp)</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> » Lsp</nav><header class="odoc-preamble"><h1>Module <code><span>Asai.Lsp</span></code></h1><p>An LSP (Language Service Protocol) server for asai</p><ul class="at-tags"><li class="alert"><span class="at-tag">alert</span> unstable The LSP backend may change significantly in the future.</li></ul></header><nav class="odoc-toc"><ul><li><a href="#language-service-protocol">Language Service Protocol</a></li></ul></nav><div class="odoc-content"><h2 id="language-service-protocol"><a href="#language-service-protocol" class="anchor"></a>Language Service Protocol</h2><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="../Diagnostic/module-type-Code/index.html">Diagnostic.Code</a>) : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>This module provides a rudimentary and incomplete implementation of the LSP protocol.</p></div></div></div></body></html> |
Oops, something went wrong.