-
Notifications
You must be signed in to change notification settings - Fork 9
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
1 changed file
with
1 addition
and
1 deletion.
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>LINT (zanuda.Zanuda_core.LINT)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><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">zanuda</a> » <a href="../index.html">Zanuda_core</a> » LINT</nav><header class="odoc-preamble"><h1>Module <code><span>Zanuda_core.LINT</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-impl"><a href="#type-impl" class="anchor"></a><code><span><span class="keyword">type</span> impl</span><span> = </span></code><ol><li id="type-impl.Untyped" class="def variant constructor anchored"><a href="#type-impl.Untyped" class="anchor"></a><code><span>| </span><span><span class="constructor">Untyped</span></span></code></li><li id="type-impl.Typed" class="def variant constructor anchored"><a href="#type-impl.Typed" class="anchor"></a><code><span>| </span><span><span class="constructor">Typed</span></span></code></li></ol></div><div class="spec-doc"><p>A type of lint's impelementation. Typed and untyped lints inspect OCaml's Parsetree/Typedtree respectively. In Clippy it corresponds to <a href="https://doc.rust-lang.org/nightly/clippy/development/lint_passes.html">early and late</a> lint passes.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-group"><a href="#type-group" class="anchor"></a><code><span><span class="keyword">type</span> group</span><span> = </span></code><ol><li id="type-group.Style" class="def variant constructor anchored"><a href="#type-group.Style" class="anchor"></a><code><span>| </span><span><span class="constructor">Style</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Code that should be written in a more idiomatic way</p><span class="comment-delim">*)</span></div></li><li id="type-group.Correctness" class="def variant constructor anchored"><a href="#type-group.Correctness" class="anchor"></a><code><span>| </span><span><span class="constructor">Correctness</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Code that is outright wrong or useless</p><span class="comment-delim">*)</span></div></li><li id="type-group.Perf" class="def variant constructor anchored"><a href="#type-group.Perf" class="anchor"></a><code><span>| </span><span><span class="constructor">Perf</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Code that can be written to run faster</p><span class="comment-delim">*)</span></div></li><li id="type-group.Restriction" class="def variant constructor anchored"><a href="#type-group.Restriction" class="anchor"></a><code><span>| </span><span><span class="constructor">Restriction</span></span></code></li><li id="type-group.Deprecated" class="def variant constructor anchored"><a href="#type-group.Deprecated" class="anchor"></a><code><span>| </span><span><span class="constructor">Deprecated</span></span></code></li><li id="type-group.Pedantic" class="def variant constructor anchored"><a href="#type-group.Pedantic" class="anchor"></a><code><span>| </span><span><span class="constructor">Pedantic</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Lints which are rather strict or might have false positives</p><span class="comment-delim">*)</span></div></li><li id="type-group.Complexity" class="def variant constructor anchored"><a href="#type-group.Complexity" class="anchor"></a><code><span>| </span><span><span class="constructor">Complexity</span></span></code></li><li id="type-group.Suspicious" class="def variant constructor anchored"><a href="#type-group.Suspicious" class="anchor"></a><code><span>| </span><span><span class="constructor">Suspicious</span></span></code></li><li id="type-group.Nursery" class="def variant constructor anchored"><a href="#type-group.Nursery" class="anchor"></a><code><span>| </span><span><span class="constructor">Nursery</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>New lints that are still under development</p><span class="comment-delim">*)</span></div></li></ol></div><div class="spec-doc"><p>Group of lints. The same as <a href="https://doc.rust-lang.org/nightly/clippy">Rust's Clippy</a></p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-level"><a href="#type-level" class="anchor"></a><code><span><span class="keyword">type</span> level</span><span> = </span></code><ol><li id="type-level.Allow" class="def variant constructor anchored"><a href="#type-level.Allow" class="anchor"></a><code><span>| </span><span><span class="constructor">Allow</span></span></code></li><li id="type-level.Warn" class="def variant constructor anchored"><a href="#type-level.Warn" class="anchor"></a><code><span>| </span><span><span class="constructor">Warn</span></span></code></li><li id="type-level.Deny" class="def variant constructor anchored"><a href="#type-level.Deny" class="anchor"></a><code><span>| </span><span><span class="constructor">Deny</span></span></code></li><li id="type-level.Deprecated" class="def variant constructor anchored"><a href="#type-level.Deprecated" class="anchor"></a><code><span>| </span><span><span class="constructor">Deprecated</span></span></code></li></ol></div><div class="spec-doc"><p>Level of lints. The same as Rust's Clippy</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-lint_source"><a href="#type-lint_source" class="anchor"></a><code><span><span class="keyword">type</span> lint_source</span><span> = </span></code><ol><li id="type-lint_source.Camelot" class="def variant constructor anchored"><a href="#type-lint_source.Camelot" class="anchor"></a><code><span>| </span><span><span class="constructor">Camelot</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Adopted from Camelot linter</p><span class="comment-delim">*)</span></div></li><li id="type-lint_source.Clippy" class="def variant constructor anchored"><a href="#type-lint_source.Clippy" class="anchor"></a><code><span>| </span><span><span class="constructor">Clippy</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Adopted from Rust's Clippy</p><span class="comment-delim">*)</span></div></li><li id="type-lint_source.FPCourse" class="def variant constructor anchored"><a href="#type-lint_source.FPCourse" class="anchor"></a><code><span>| </span><span><span class="constructor">FPCourse</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Invented after reviewing Kakadu's student's OCaml homeworks</p><span class="comment-delim">*)</span></div></li><li id="type-lint_source.Other" class="def variant constructor anchored"><a href="#type-lint_source.Other" class="anchor"></a><code><span>| </span><span><span class="constructor">Other</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The source is not specified</p><span class="comment-delim">*)</span></div></li></ol></div><div class="spec-doc"><p>How various lints were invented</p></div></div><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-GENERAL"><a href="#module-type-GENERAL" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-GENERAL/index.html">GENERAL</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-type anchored" id="module-type-UNTYPED"><a href="#module-type-UNTYPED" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-UNTYPED/index.html">UNTYPED</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-type anchored" id="module-type-TYPED"><a href="#module-type-TYPED" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-TYPED/index.html">TYPED</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-type anchored" id="module-type-UNUSED_DECLS"><a href="#module-type-UNUSED_DECLS" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-UNUSED_DECLS/index.html">UNUSED_DECLS</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-type anchored" id="module-type-REPORTER"><a href="#module-type-REPORTER" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-REPORTER/index.html">REPORTER</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html> | ||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>LINT (zanuda.Zanuda_core.LINT)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><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">zanuda</a> » <a href="../index.html">Zanuda_core</a> » LINT</nav><header class="odoc-preamble"><h1>Module <code><span>Zanuda_core.LINT</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-impl"><a href="#type-impl" class="anchor"></a><code><span><span class="keyword">type</span> impl</span><span> = </span></code><ol><li id="type-impl.Untyped" class="def variant constructor anchored"><a href="#type-impl.Untyped" class="anchor"></a><code><span>| </span><span><span class="constructor">Untyped</span></span></code></li><li id="type-impl.Typed" class="def variant constructor anchored"><a href="#type-impl.Typed" class="anchor"></a><code><span>| </span><span><span class="constructor">Typed</span></span></code></li></ol></div><div class="spec-doc"><p>A type of lint's implementation. Typed and untyped lints inspect OCaml's Parsetree/Typedtree respectively. In Clippy it corresponds to <a href="https://doc.rust-lang.org/nightly/clippy/development/lint_passes.html">early and late</a> lint passes.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-group"><a href="#type-group" class="anchor"></a><code><span><span class="keyword">type</span> group</span><span> = </span></code><ol><li id="type-group.Style" class="def variant constructor anchored"><a href="#type-group.Style" class="anchor"></a><code><span>| </span><span><span class="constructor">Style</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Code that should be written in a more idiomatic way</p><span class="comment-delim">*)</span></div></li><li id="type-group.Correctness" class="def variant constructor anchored"><a href="#type-group.Correctness" class="anchor"></a><code><span>| </span><span><span class="constructor">Correctness</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Code that is outright wrong or useless</p><span class="comment-delim">*)</span></div></li><li id="type-group.Perf" class="def variant constructor anchored"><a href="#type-group.Perf" class="anchor"></a><code><span>| </span><span><span class="constructor">Perf</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Code that can be written to run faster</p><span class="comment-delim">*)</span></div></li><li id="type-group.Restriction" class="def variant constructor anchored"><a href="#type-group.Restriction" class="anchor"></a><code><span>| </span><span><span class="constructor">Restriction</span></span></code></li><li id="type-group.Deprecated" class="def variant constructor anchored"><a href="#type-group.Deprecated" class="anchor"></a><code><span>| </span><span><span class="constructor">Deprecated</span></span></code></li><li id="type-group.Pedantic" class="def variant constructor anchored"><a href="#type-group.Pedantic" class="anchor"></a><code><span>| </span><span><span class="constructor">Pedantic</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Lints which are rather strict or might have false positives</p><span class="comment-delim">*)</span></div></li><li id="type-group.Complexity" class="def variant constructor anchored"><a href="#type-group.Complexity" class="anchor"></a><code><span>| </span><span><span class="constructor">Complexity</span></span></code></li><li id="type-group.Suspicious" class="def variant constructor anchored"><a href="#type-group.Suspicious" class="anchor"></a><code><span>| </span><span><span class="constructor">Suspicious</span></span></code></li><li id="type-group.Nursery" class="def variant constructor anchored"><a href="#type-group.Nursery" class="anchor"></a><code><span>| </span><span><span class="constructor">Nursery</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>New lints that are still under development</p><span class="comment-delim">*)</span></div></li></ol></div><div class="spec-doc"><p>Group of lints. The same as <a href="https://doc.rust-lang.org/nightly/clippy">Rust's Clippy</a></p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-level"><a href="#type-level" class="anchor"></a><code><span><span class="keyword">type</span> level</span><span> = </span></code><ol><li id="type-level.Allow" class="def variant constructor anchored"><a href="#type-level.Allow" class="anchor"></a><code><span>| </span><span><span class="constructor">Allow</span></span></code></li><li id="type-level.Warn" class="def variant constructor anchored"><a href="#type-level.Warn" class="anchor"></a><code><span>| </span><span><span class="constructor">Warn</span></span></code></li><li id="type-level.Deny" class="def variant constructor anchored"><a href="#type-level.Deny" class="anchor"></a><code><span>| </span><span><span class="constructor">Deny</span></span></code></li><li id="type-level.Deprecated" class="def variant constructor anchored"><a href="#type-level.Deprecated" class="anchor"></a><code><span>| </span><span><span class="constructor">Deprecated</span></span></code></li></ol></div><div class="spec-doc"><p>Level of lints. The same as Rust's Clippy</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-lint_source"><a href="#type-lint_source" class="anchor"></a><code><span><span class="keyword">type</span> lint_source</span><span> = </span></code><ol><li id="type-lint_source.Camelot" class="def variant constructor anchored"><a href="#type-lint_source.Camelot" class="anchor"></a><code><span>| </span><span><span class="constructor">Camelot</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Adopted from Camelot linter</p><span class="comment-delim">*)</span></div></li><li id="type-lint_source.Clippy" class="def variant constructor anchored"><a href="#type-lint_source.Clippy" class="anchor"></a><code><span>| </span><span><span class="constructor">Clippy</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Adopted from Rust's Clippy</p><span class="comment-delim">*)</span></div></li><li id="type-lint_source.FPCourse" class="def variant constructor anchored"><a href="#type-lint_source.FPCourse" class="anchor"></a><code><span>| </span><span><span class="constructor">FPCourse</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Invented after reviewing Kakadu's student's OCaml homeworks</p><span class="comment-delim">*)</span></div></li><li id="type-lint_source.Other" class="def variant constructor anchored"><a href="#type-lint_source.Other" class="anchor"></a><code><span>| </span><span><span class="constructor">Other</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The source is not specified</p><span class="comment-delim">*)</span></div></li></ol></div><div class="spec-doc"><p>How various lints were invented</p></div></div><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-GENERAL"><a href="#module-type-GENERAL" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-GENERAL/index.html">GENERAL</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-type anchored" id="module-type-UNTYPED"><a href="#module-type-UNTYPED" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-UNTYPED/index.html">UNTYPED</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-type anchored" id="module-type-TYPED"><a href="#module-type-TYPED" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-TYPED/index.html">TYPED</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-type anchored" id="module-type-UNUSED_DECLS"><a href="#module-type-UNUSED_DECLS" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-UNUSED_DECLS/index.html">UNUSED_DECLS</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-type anchored" id="module-type-REPORTER"><a href="#module-type-REPORTER" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-REPORTER/index.html">REPORTER</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html> |