iv-org-mirror/shard-ameba
1
0
Fork 0
mirror of https://gitea.invidious.io/iv-org/shard-ameba.git synced 2024-08-15 00:53:29 +00:00
Code Issues Projects Releases Packages Wiki Activity

Deploying to gh-pages from @ 48b15b9bf8 🚀

Browse source
This commit is contained in:
Sija 2021-10-19 09:45:33 +00:00
parent 42809c9681
commit f760465482
106 changed files with 5612 additions and 4623 deletions
Download patch file Download diff file Expand all files Collapse all files

87
Ameba/Rule/Style/LargeNumbers.html
View file

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.36.1">
<meta name="generator" content="Crystal Docs 1.1.1">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
@ -286,6 +286,11 @@
<ul>
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
<a href="../../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
<a href="../../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
@ -642,21 +647,15 @@
<p>A rule that disallows usage of large numbers without underscore.
These do not affect the value of the number, but can help read
large numbers more easily.</p>
<p>For example, these are considered invalid:</p>
<pre><code class="language-crystal"><span class="n">10000</span>
<span class="n">141592654</span>
<span class="n">5.12345</span></code></pre>
<p>And has to be rewritten as the following:</p>
<pre><code class="language-crystal"><span class="n">10_000</span>
<span class="n">141_592_654</span>
<span class="n">5.123_45</span></code></pre>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Style/LargeNumbers:
Enabled: true
IntMinDigits: 5 # i.e. integers higher than 9999</code></pre>
@ -700,7 +699,7 @@ large numbers more easily.</p>
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/style/large_numbers.cr#L29" target="_blank">
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/style/large_numbers.cr#L29" target="_blank">
ameba/rule/style/large_numbers.cr
</a>
@ -741,12 +740,12 @@ large numbers more easily.</p>
<ul class="list-summary">
<li class="entry-summary">
<a href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
<a href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
</li>
<li class="entry-summary">
<a href="#new(config=nil)-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
<a href="#new%28config%3Dnil%29-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
<div class="summary"><p>A rule that disallows usage of large numbers without underscore.</p></div>
@ -769,57 +768,57 @@ large numbers more easily.</p>
<ul class="list-summary">
<li class="entry-summary">
<a href="#description:String-instance-method" class="signature"><strong>#description</strong> : String</a>
<a href="#description%3AString-instance-method" class="signature"><strong>#description</strong> : String</a>
</li>
<li class="entry-summary">
<a href="#description=(description:String)-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
<a href="#description%3D%28description%3AString%29-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
</li>
<li class="entry-summary">
<a href="#enabled:Bool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
<a href="#enabled%3ABool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
</li>
<li class="entry-summary">
<a href="#enabled=(enabled:Bool)-instance-method" class="signature"><strong>#enabled=</strong>(enabled : Bool)</a>
<a href="#enabled%3D%28enabled%3ABool%29-instance-method" class="signature"><strong>#enabled=</strong>(enabled : Bool)</a>
</li>
<li class="entry-summary">
<a href="#excluded:Array(String)?-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
<a href="#excluded%3AArray%28String%29%3F-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
</li>
<li class="entry-summary">
<a href="#excluded=(excluded:Array(String)?)-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
<a href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
</li>
<li class="entry-summary">
<a href="#int_min_digits:Int32-instance-method" class="signature"><strong>#int_min_digits</strong> : Int32</a>
<a href="#int_min_digits%3AInt32-instance-method" class="signature"><strong>#int_min_digits</strong> : Int32</a>
</li>
<li class="entry-summary">
<a href="#int_min_digits=(int_min_digits:Int32)-instance-method" class="signature"><strong>#int_min_digits=</strong>(int_min_digits : Int32)</a>
<a href="#int_min_digits%3D%28int_min_digits%3AInt32%29-instance-method" class="signature"><strong>#int_min_digits=</strong>(int_min_digits : Int32)</a>
</li>
<li class="entry-summary">
<a href="#severity:Ameba::Severity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
<a href="#severity%3AAmeba%3A%3ASeverity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
</li>
<li class="entry-summary">
<a href="#severity=(severity)-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
<a href="#severity%3D%28severity%29-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
</li>
<li class="entry-summary">
<a href="#test(source)-instance-method" class="signature"><strong>#test</strong>(source)</a>
<a href="#test%28source%29-instance-method" class="signature"><strong>#test</strong>(source)</a>
</li>
@ -856,17 +855,17 @@ large numbers more easily.</p>
<h3>Instance methods inherited from class <code><a href="../../../Ameba/Rule/Base.html">Ameba::Rule::Base</a></code></h3>
<a href="../../../Ameba/Rule/Base.html#==(other)-instance-method" class="tooltip">
<a href="../../../Ameba/Rule/Base.html#%3D%3D%28other%29-instance-method" class="tooltip">
<span>==(other)</span>
==</a>,
<a href="../../../Ameba/Rule/Base.html#catch(source:Source)-instance-method" class="tooltip">
<a href="../../../Ameba/Rule/Base.html#catch%28source%3ASource%29-instance-method" class="tooltip">
<span>catch(source : Source)</span>
catch</a>,
<a href="../../../Ameba/Rule/Base.html#excluded?(source)-instance-method" class="tooltip">
<a href="../../../Ameba/Rule/Base.html#excluded%3F%28source%29-instance-method" class="tooltip">
<span>excluded?(source)</span>
excluded?</a>,
@ -886,12 +885,12 @@ large numbers more easily.</p>
name</a>,
<a href="../../../Ameba/Rule/Base.html#special?-instance-method" class="tooltip">
<a href="../../../Ameba/Rule/Base.html#special%3F-instance-method" class="tooltip">
<span>special?</span>
special?</a>,
<a href="../../../Ameba/Rule/Base.html#test(source:Source,node:Crystal::ASTNode,*opts)-instance-method" class="tooltip">
<a href="../../../Ameba/Rule/Base.html#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method" class="tooltip">
<span>test(source : Source, node : Crystal::ASTNode, *opts)<br/>test(source : Source)</span>
test</a>
@ -961,7 +960,7 @@ large numbers more easily.</p>
def self.<strong>new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
<a class="method-permalink" href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method">#</a>
<a class="method-permalink" href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method">#</a>
</div>
<br/>
@ -975,7 +974,7 @@ large numbers more easily.</p>
def self.<strong>new</strong>(config = <span class="n">nil</span>)
<a class="method-permalink" href="#new(config=nil)-class-method">#</a>
<a class="method-permalink" href="#new%28config%3Dnil%29-class-method">#</a>
</div>
<div class="doc">
@ -983,21 +982,15 @@ large numbers more easily.</p>
<p>A rule that disallows usage of large numbers without underscore.
These do not affect the value of the number, but can help read
large numbers more easily.</p>
<p>For example, these are considered invalid:</p>
<pre><code class="language-crystal"><span class="n">10000</span>
<span class="n">141592654</span>
<span class="n">5.12345</span></code></pre>
<p>And has to be rewritten as the following:</p>
<pre><code class="language-crystal"><span class="n">10_000</span>
<span class="n">141_592_654</span>
<span class="n">5.123_45</span></code></pre>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Style/LargeNumbers:
Enabled: true
IntMinDigits: 5 # i.e. integers higher than 9999</code></pre>
@ -1006,7 +999,7 @@ large numbers more easily.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/style/large_numbers.cr#L29" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/style/large_numbers.cr#L29" target="_blank">View source</a>]
</div>
</div>
@ -1030,7 +1023,7 @@ large numbers more easily.</p>
def <strong>description</strong> : String
<a class="method-permalink" href="#description:String-instance-method">#</a>
<a class="method-permalink" href="#description%3AString-instance-method">#</a>
</div>
<br/>
@ -1044,7 +1037,7 @@ large numbers more easily.</p>
def <strong>description=</strong>(description : String)
<a class="method-permalink" href="#description=(description:String)-instance-method">#</a>
<a class="method-permalink" href="#description%3D%28description%3AString%29-instance-method">#</a>
</div>
<br/>
@ -1058,7 +1051,7 @@ large numbers more easily.</p>
def <strong>enabled</strong> : Bool
<a class="method-permalink" href="#enabled:Bool-instance-method">#</a>
<a class="method-permalink" href="#enabled%3ABool-instance-method">#</a>
</div>
<br/>
@ -1072,7 +1065,7 @@ large numbers more easily.</p>
def <strong>enabled=</strong>(enabled : Bool)
<a class="method-permalink" href="#enabled=(enabled:Bool)-instance-method">#</a>
<a class="method-permalink" href="#enabled%3D%28enabled%3ABool%29-instance-method">#</a>
</div>
<br/>
@ -1086,7 +1079,7 @@ large numbers more easily.</p>
def <strong>excluded</strong> : Array(String)?
<a class="method-permalink" href="#excluded:Array(String)?-instance-method">#</a>
<a class="method-permalink" href="#excluded%3AArray%28String%29%3F-instance-method">#</a>
</div>
<br/>
@ -1100,7 +1093,7 @@ large numbers more easily.</p>
def <strong>excluded=</strong>(excluded : Array(String)?)
<a class="method-permalink" href="#excluded=(excluded:Array(String)?)-instance-method">#</a>
<a class="method-permalink" href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method">#</a>
</div>
<br/>
@ -1114,7 +1107,7 @@ large numbers more easily.</p>
def <strong>int_min_digits</strong> : Int32
<a class="method-permalink" href="#int_min_digits:Int32-instance-method">#</a>
<a class="method-permalink" href="#int_min_digits%3AInt32-instance-method">#</a>
</div>
<br/>
@ -1128,7 +1121,7 @@ large numbers more easily.</p>
def <strong>int_min_digits=</strong>(int_min_digits : Int32)
<a class="method-permalink" href="#int_min_digits=(int_min_digits:Int32)-instance-method">#</a>
<a class="method-permalink" href="#int_min_digits%3D%28int_min_digits%3AInt32%29-instance-method">#</a>
</div>
<br/>
@ -1142,7 +1135,7 @@ large numbers more easily.</p>
def <strong>severity</strong> : <a href="../../../Ameba/Severity.html">Ameba::Severity</a>
<a class="method-permalink" href="#severity:Ameba::Severity-instance-method">#</a>
<a class="method-permalink" href="#severity%3AAmeba%3A%3ASeverity-instance-method">#</a>
</div>
<br/>
@ -1156,7 +1149,7 @@ large numbers more easily.</p>
def <strong>severity=</strong>(severity)
<a class="method-permalink" href="#severity=(severity)-instance-method">#</a>
<a class="method-permalink" href="#severity%3D%28severity%29-instance-method">#</a>
</div>
<br/>
@ -1170,13 +1163,13 @@ large numbers more easily.</p>
def <strong>test</strong>(source)
<a class="method-permalink" href="#test(source)-instance-method">#</a>
<a class="method-permalink" href="#test%28source%29-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/style/large_numbers.cr#L38" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/style/large_numbers.cr#L38" target="_blank">View source</a>]
</div>
</div>