Skip to content

Commit

Permalink
deploy: 212dc9b
Browse files Browse the repository at this point in the history
  • Loading branch information
Kakadu committed Aug 4, 2024
1 parent e698f92 commit 6ccb698
Show file tree
Hide file tree
Showing 11 changed files with 48 additions and 40 deletions.
2 changes: 1 addition & 1 deletion api/reviewer/Diff_parser/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>Diff_parser (reviewer.Diff_parser)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../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">reviewer</a> &#x00BB; Diff_parser</nav><header class="odoc-preamble"><h1>Module <code><span>Diff_parser</span></code></h1><p>Copyright 2021-2023, Kakadu.</p></header><div class="odoc-content"><p>SPDX-License-Identifier: LGPL-3.0-or-later</p><div class="odoc-spec"><div class="spec value anchored" id="val-parse_whole_file"><a href="#val-parse_whole_file" class="anchor"></a><code><span><span class="keyword">val</span> parse_whole_file : <span><span><a href="../Types/index.html#type-file_info">Types.file_info</a> list</span> <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div><div class="spec-doc"><p>Parser of the diff file. The grammar is similar too</p><p>diff ::= ( head chunk* )*</p><p>See also <code>file_head</code> and <code>a_chunk</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-parse_string"><a href="#val-parse_string" class="anchor"></a><code><span><span class="keyword">val</span> parse_string : <span>string <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><a href="../Types/index.html#type-file_info">Types.file_info</a> list</span>, string)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div><div class="spec-doc"><p>Main entry point. Uses <code>parse_whole_file</code> under the hood</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-file_head"><a href="#val-file_head" class="anchor"></a><code><span><span class="keyword">val</span> file_head : <span><span><span>(string * string)</span> option</span> <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div><div class="spec-doc"><p>Parse header of the diff file</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-a_chunk"><a href="#val-a_chunk" class="anchor"></a><code><span><span class="keyword">val</span> a_chunk : <span><a href="../Types/index.html#type-chunk">Types.chunk</a> <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div><div class="spec-doc"><p>Parses hunk for the file</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-recover_lines"><a href="#val-recover_lines" class="anchor"></a><code><span><span class="keyword">val</span> recover_lines : <span>string <span class="arrow">&#45;&gt;</span></span> <span><span>(int * <span>(int * int)</span>)</span> list</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-lookup"><a href="#val-lookup" class="anchor"></a><code><span><span class="keyword">val</span> lookup : <span><span><a href="../Types/index.html#type-file_info">Types.file_info</a> list</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">file</span>:string <span class="arrow">&#45;&gt;</span></span> <span><span class="label">line</span>:int <span class="arrow">&#45;&gt;</span></span> <span>int option</span></span></code></div><div class="spec-doc"><p>The call <code>lookup db ~file ~line</code> searches in the list of file differences by a file name <code>file</code> and a file line <code>line</code> the corresponding line of in diff file (counting from the beginning of the information about <code>file</code>).</p><p>Github API requires this information to submit a review</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_logging"><a href="#val-set_logging" class="anchor"></a><code><span><span class="keyword">val</span> set_logging : <span>bool <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Enable or disable trace logging</p></div></div></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Diff_parser (reviewer.Diff_parser)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../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">reviewer</a> &#x00BB; Diff_parser</nav><header class="odoc-preamble"><h1>Module <code><span>Diff_parser</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-parse_whole_file"><a href="#val-parse_whole_file" class="anchor"></a><code><span><span class="keyword">val</span> parse_whole_file : <span><span><a href="../Types/index.html#type-file_info">Types.file_info</a> list</span> <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div><div class="spec-doc"><p>Parser of the diff file. The grammar is similar too</p><p>diff ::= ( head chunk* )*</p><p>See also <a href="#val-file_head"><code>file_head</code></a> and <a href="#val-a_chunk"><code>a_chunk</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-parse_string"><a href="#val-parse_string" class="anchor"></a><code><span><span class="keyword">val</span> parse_string : <span>string <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><a href="../Types/index.html#type-file_info">Types.file_info</a> list</span>, string)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div><div class="spec-doc"><p>Main entry point. Uses <code>parse_whole_file</code> under the hood</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-file_head"><a href="#val-file_head" class="anchor"></a><code><span><span class="keyword">val</span> file_head : <span><span><span>(string * string)</span> option</span> <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div><div class="spec-doc"><p>Parse header of the diff file</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-a_chunk"><a href="#val-a_chunk" class="anchor"></a><code><span><span class="keyword">val</span> a_chunk : <span><a href="../Types/index.html#type-chunk">Types.chunk</a> <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div><div class="spec-doc"><p>Parses hunk for the file</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-recover_lines"><a href="#val-recover_lines" class="anchor"></a><code><span><span class="keyword">val</span> recover_lines : <span>string <span class="arrow">&#45;&gt;</span></span> <span><span>(int * <span>(int * int)</span>)</span> list</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-lookup"><a href="#val-lookup" class="anchor"></a><code><span><span class="keyword">val</span> lookup : <span><span><a href="../Types/index.html#type-file_info">Types.file_info</a> list</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">file</span>:string <span class="arrow">&#45;&gt;</span></span> <span><span class="label">line</span>:int <span class="arrow">&#45;&gt;</span></span> <span>int option</span></span></code></div><div class="spec-doc"><p>The call <code>lookup db ~file ~line</code> searches in the list of file differences by a file name <code>file</code> and a file line <code>line</code> the corresponding line of in diff file (counting from the beginning of the information about <code>file</code>).</p><p>Github API requires this information to submit a review</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_logging"><a href="#val-set_logging" class="anchor"></a><code><span><span class="keyword">val</span> set_logging : <span>bool <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Enable or disable trace logging</p></div></div></div></body></html>
2 changes: 1 addition & 1 deletion api/reviewer/Line_parser/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>Line_parser (reviewer.Line_parser)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../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">reviewer</a> &#x00BB; Line_parser</nav><header class="odoc-preamble"><h1>Module <code><span>Line_parser</span></code></h1><p>Copyright 2021-2024, Kakadu and contributors</p></header><div class="odoc-content"><p>SPDX-License-Identifier: LGPL-3.0-or-later</p><div class="odoc-spec"><div class="spec value anchored" id="val-run"><a href="#val-run" class="anchor"></a><code><span><span class="keyword">val</span> run : <span><span class="optlabel">?info</span>:string <span class="arrow">&#45;&gt;</span></span> <span><span><span class="type-var">'a</span> <span class="xref-unresolved">Angstrom</span>.t</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div><div class="spec-doc"><p><code>run ?info p</code> trims line break in the input string and runs parser <code>p</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-diff_cmd"><a href="#val-diff_cmd" class="anchor"></a><code><span><span class="keyword">val</span> diff_cmd : <span>unit <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-file_mode"><a href="#val-file_mode" class="anchor"></a><code><span><span class="keyword">val</span> file_mode : <span>unit <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-similarity"><a href="#val-similarity" class="anchor"></a><code><span><span class="keyword">val</span> similarity : <span>unit <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-rename"><a href="#val-rename" class="anchor"></a><code><span><span class="keyword">val</span> rename : <span>unit <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-index"><a href="#val-index" class="anchor"></a><code><span><span class="keyword">val</span> index : <span>unit <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-binary_files_differ"><a href="#val-binary_files_differ" class="anchor"></a><code><span><span class="keyword">val</span> binary_files_differ : <span>unit <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-old_mode"><a href="#val-old_mode" class="anchor"></a><code><span><span class="keyword">val</span> old_mode : <span>unit <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-new_mode"><a href="#val-new_mode" class="anchor"></a><code><span><span class="keyword">val</span> new_mode : <span>unit <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-remove_file"><a href="#val-remove_file" class="anchor"></a><code><span><span class="keyword">val</span> remove_file : <span>string <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_file"><a href="#val-add_file" class="anchor"></a><code><span><span class="keyword">val</span> add_file : <span>string <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pos_num"><a href="#val-pos_num" class="anchor"></a><code><span><span class="keyword">val</span> pos_num : <span>int <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-chunk_head"><a href="#val-chunk_head" class="anchor"></a><code><span><span class="keyword">val</span> chunk_head : <span><a href="../Types/index.html#type-chunk_info">Types.chunk_info</a> <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-chunk_item"><a href="#val-chunk_item" class="anchor"></a><code><span><span class="keyword">val</span> chunk_item : <span><span>(<a href="../Types/index.html#type-kind">Types.kind</a> * string)</span> <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-no_new_line_eof"><a href="#val-no_new_line_eof" class="anchor"></a><code><span><span class="keyword">val</span> no_new_line_eof : <span>unit <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_logging"><a href="#val-set_logging" class="anchor"></a><code><span><span class="keyword">val</span> set_logging : <span>bool <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Line_parser (reviewer.Line_parser)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../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">reviewer</a> &#x00BB; Line_parser</nav><header class="odoc-preamble"><h1>Module <code><span>Line_parser</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-run"><a href="#val-run" class="anchor"></a><code><span><span class="keyword">val</span> run : <span><span class="optlabel">?info</span>:string <span class="arrow">&#45;&gt;</span></span> <span><span><span class="type-var">'a</span> <span class="xref-unresolved">Angstrom</span>.t</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div><div class="spec-doc"><p><code>run ?info p</code> trims line break in the input string and runs parser <code>p</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-diff_cmd"><a href="#val-diff_cmd" class="anchor"></a><code><span><span class="keyword">val</span> diff_cmd : <span>unit <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-file_mode"><a href="#val-file_mode" class="anchor"></a><code><span><span class="keyword">val</span> file_mode : <span>unit <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-similarity"><a href="#val-similarity" class="anchor"></a><code><span><span class="keyword">val</span> similarity : <span>unit <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-rename"><a href="#val-rename" class="anchor"></a><code><span><span class="keyword">val</span> rename : <span>unit <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-index"><a href="#val-index" class="anchor"></a><code><span><span class="keyword">val</span> index : <span>unit <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-binary_files_differ"><a href="#val-binary_files_differ" class="anchor"></a><code><span><span class="keyword">val</span> binary_files_differ : <span>unit <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-old_mode"><a href="#val-old_mode" class="anchor"></a><code><span><span class="keyword">val</span> old_mode : <span>unit <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-new_mode"><a href="#val-new_mode" class="anchor"></a><code><span><span class="keyword">val</span> new_mode : <span>unit <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-remove_file"><a href="#val-remove_file" class="anchor"></a><code><span><span class="keyword">val</span> remove_file : <span>string <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_file"><a href="#val-add_file" class="anchor"></a><code><span><span class="keyword">val</span> add_file : <span>string <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pos_num"><a href="#val-pos_num" class="anchor"></a><code><span><span class="keyword">val</span> pos_num : <span>int <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-chunk_head"><a href="#val-chunk_head" class="anchor"></a><code><span><span class="keyword">val</span> chunk_head : <span><a href="../Types/index.html#type-chunk_info">Types.chunk_info</a> <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-chunk_item"><a href="#val-chunk_item" class="anchor"></a><code><span><span class="keyword">val</span> chunk_item : <span><span>(<a href="../Types/index.html#type-kind">Types.kind</a> * string)</span> <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-no_new_line_eof"><a href="#val-no_new_line_eof" class="anchor"></a><code><span><span class="keyword">val</span> no_new_line_eof : <span>unit <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set_logging"><a href="#val-set_logging" class="anchor"></a><code><span><span class="keyword">val</span> set_logging : <span>bool <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div></div></body></html>
Loading

0 comments on commit 6ccb698

Please sign in to comment.