Skip to content

Commit

Permalink
Regenerated docs for 0.7.2
Browse files Browse the repository at this point in the history
  • Loading branch information
mpeterv committed Jan 3, 2015
1 parent 4a29a46 commit 33185a6
Show file tree
Hide file tree
Showing 11 changed files with 36 additions and 33 deletions.
2 changes: 1 addition & 1 deletion doc/_sources/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ Contents:

Luacheck provides a command line interface as well as a Lua module which can be used by other programs.

This is the documentation for the 0.7.1 version.
This is the documentation for the 0.7.2 version.
9 changes: 5 additions & 4 deletions doc/_sources/warnings.txt
Original file line number Diff line number Diff line change
Expand Up @@ -43,18 +43,19 @@ Detection of unused arguments and loop variables can be disabled using ``-a``/``
Unused values
^^^^^^^^^^^^^

Luacheck also detects unused values: redundant assignments to variables which are then not used before another assignment. As an example, in the following snippet value assigned to ``foo`` on line 4 is unused, as it is always overwritten on line 7:
Luacheck also detects unused values: redundant assignments to variables which are then not used before another assignment. As an example, in the following snippet value assigned to ``foo`` on line 1 is unused, as it is overwritten in both branches of ``if`` statement before being used:

.. code-block:: lua
:linenos:

local foo
local foo = expr1()

if condition() then
foo = expr1()
foo = expr2()
else
foo = expr3()
end

foo = expr2()
return foo

Detection of unused values can be disabled using ``-v``/``--no-unused-values`` CLI option or ``unused_values`` config option.
Expand Down
6 changes: 3 additions & 3 deletions doc/cli.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Command line interface &mdash; luacheck 0.7.1 documentation</title>
<title>Command line interface &mdash; luacheck 0.7.2 documentation</title>



Expand All @@ -28,7 +28,7 @@



<link rel="top" title="luacheck 0.7.1 documentation" href="index.html"/>
<link rel="top" title="luacheck 0.7.2 documentation" href="index.html"/>
<link rel="next" title="Configuration file" href="config.html"/>
<link rel="prev" title="Types of warnings" href="warnings.html"/>

Expand Down Expand Up @@ -301,7 +301,7 @@ <h1>Command line interface<a class="headerlink" href="#command-line-interface" t
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'0.7.1',
VERSION:'0.7.2',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
Expand Down
6 changes: 3 additions & 3 deletions doc/config.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Configuration file &mdash; luacheck 0.7.1 documentation</title>
<title>Configuration file &mdash; luacheck 0.7.2 documentation</title>



Expand All @@ -28,7 +28,7 @@



<link rel="top" title="luacheck 0.7.1 documentation" href="index.html"/>
<link rel="top" title="luacheck 0.7.2 documentation" href="index.html"/>
<link rel="next" title="Luacheck module" href="module.html"/>
<link rel="prev" title="Command line interface" href="cli.html"/>

Expand Down Expand Up @@ -193,7 +193,7 @@ <h2>Per-file overrides<a class="headerlink" href="#per-file-overrides" title="Pe
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'0.7.1',
VERSION:'0.7.2',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
Expand Down
6 changes: 3 additions & 3 deletions doc/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Index &mdash; luacheck 0.7.1 documentation</title>
<title>Index &mdash; luacheck 0.7.2 documentation</title>



Expand All @@ -29,7 +29,7 @@



<link rel="top" title="luacheck 0.7.1 documentation" href="index.html"/>
<link rel="top" title="luacheck 0.7.2 documentation" href="index.html"/>


<script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
Expand Down Expand Up @@ -145,7 +145,7 @@ <h1 id="index">Index</h1>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'0.7.1',
VERSION:'0.7.2',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
Expand Down
8 changes: 4 additions & 4 deletions doc/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Luacheck documentation &mdash; luacheck 0.7.1 documentation</title>
<title>Luacheck documentation &mdash; luacheck 0.7.2 documentation</title>



Expand All @@ -28,7 +28,7 @@



<link rel="top" title="luacheck 0.7.1 documentation" href="#"/>
<link rel="top" title="luacheck 0.7.2 documentation" href="#"/>
<link rel="next" title="Types of warnings" href="warnings.html"/>


Expand Down Expand Up @@ -150,7 +150,7 @@ <h1>Luacheck documentation<a class="headerlink" href="#luacheck-documentation" t
</div>
<p><a class="reference external" href="https://github.com/mpeterv/luacheck/">Luacheck</a> is a tool for linting and static analysis of <a class="reference external" href="http://www.lua.org/">Lua</a> code. It is able to spot usage of undefined global variables, unused local variables and a few other typical problems within Lua programs.</p>
<p>Luacheck provides a command line interface as well as a Lua module which can be used by other programs.</p>
<p>This is the documentation for the 0.7.1 version.</p>
<p>This is the documentation for the 0.7.2 version.</p>
</div>


Expand Down Expand Up @@ -189,7 +189,7 @@ <h1>Luacheck documentation<a class="headerlink" href="#luacheck-documentation" t
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'0.7.1',
VERSION:'0.7.2',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
Expand Down
6 changes: 3 additions & 3 deletions doc/module.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Luacheck module &mdash; luacheck 0.7.1 documentation</title>
<title>Luacheck module &mdash; luacheck 0.7.2 documentation</title>



Expand All @@ -28,7 +28,7 @@



<link rel="top" title="luacheck 0.7.1 documentation" href="index.html"/>
<link rel="top" title="luacheck 0.7.2 documentation" href="index.html"/>
<link rel="prev" title="Configuration file" href="config.html"/>


Expand Down Expand Up @@ -243,7 +243,7 @@ <h2>Report format<a class="headerlink" href="#report-format" title="Permalink to
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'0.7.1',
VERSION:'0.7.2',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
Expand Down
2 changes: 1 addition & 1 deletion doc/objects.inv
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Sphinx inventory version 2
# Project: luacheck
# Version: 0.7.1
# Version: 0.7.2
# The remainder of this file is compressed using zlib.
xڅ��� �;O�D�3����F�=A7*#)��m�����1� (��Ym%����XCq���v0|�r� ��h7�"�oN�L_~k^؇��GpL� O�7�6k�uT$��X7z�Y�S[��]��3�\$Ʌ鍳�yBɣ�����WB�(�V4�]7���̯ΘEpx��v֋�nQ����)�]��N
Expand Down
6 changes: 3 additions & 3 deletions doc/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Search &mdash; luacheck 0.7.1 documentation</title>
<title>Search &mdash; luacheck 0.7.2 documentation</title>



Expand All @@ -28,7 +28,7 @@



<link rel="top" title="luacheck 0.7.1 documentation" href="index.html"/>
<link rel="top" title="luacheck 0.7.2 documentation" href="index.html"/>


<script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
Expand Down Expand Up @@ -150,7 +150,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'0.7.1',
VERSION:'0.7.2',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
Expand Down
2 changes: 1 addition & 1 deletion doc/searchindex.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 9 additions & 7 deletions doc/warnings.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Types of warnings &mdash; luacheck 0.7.1 documentation</title>
<title>Types of warnings &mdash; luacheck 0.7.2 documentation</title>



Expand All @@ -28,7 +28,7 @@



<link rel="top" title="luacheck 0.7.1 documentation" href="index.html"/>
<link rel="top" title="luacheck 0.7.2 documentation" href="index.html"/>
<link rel="next" title="Command line interface" href="cli.html"/>
<link rel="prev" title="Luacheck documentation" href="index.html"/>

Expand Down Expand Up @@ -143,21 +143,23 @@ <h2>Unused variables<a class="headerlink" href="#unused-variables" title="Permal
<p>Detection of unused arguments and loop variables can be disabled using <tt class="docutils literal"><span class="pre">-a</span></tt>/<tt class="docutils literal"><span class="pre">--no-unused-args</span></tt> CLI option or <tt class="docutils literal"><span class="pre">unused_args</span></tt> config option.</p>
<div class="section" id="unused-values">
<h3>Unused values<a class="headerlink" href="#unused-values" title="Permalink to this headline"></a></h3>
<p>Luacheck also detects unused values: redundant assignments to variables which are then not used before another assignment. As an example, in the following snippet value assigned to <tt class="docutils literal"><span class="pre">foo</span></tt> on line 4 is unused, as it is always overwritten on line 7:</p>
<p>Luacheck also detects unused values: redundant assignments to variables which are then not used before another assignment. As an example, in the following snippet value assigned to <tt class="docutils literal"><span class="pre">foo</span></tt> on line 1 is unused, as it is overwritten in both branches of <tt class="docutils literal"><span class="pre">if</span></tt> statement before being used:</p>
<div class="highlight-lua"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1
2
3
4
5
6
7
8</pre></div></td><td class="code"><div class="highlight"><pre><span class="kd">local</span> <span class="n">foo</span>
8
9</pre></div></td><td class="code"><div class="highlight"><pre><span class="kd">local</span> <span class="n">foo</span> <span class="o">=</span> <span class="n">expr1</span><span class="p">()</span>

<span class="k">if</span> <span class="n">condition</span><span class="p">()</span> <span class="k">then</span>
<span class="n">foo</span> <span class="o">=</span> <span class="n">expr1</span><span class="p">()</span>
<span class="n">foo</span> <span class="o">=</span> <span class="n">expr2</span><span class="p">()</span>
<span class="k">else</span>
<span class="n">foo</span> <span class="o">=</span> <span class="n">expr3</span><span class="p">()</span>
<span class="k">end</span>

<span class="n">foo</span> <span class="o">=</span> <span class="n">expr2</span><span class="p">()</span>
<span class="k">return</span> <span class="n">foo</span>
</pre></div>
</td></tr></table></div>
Expand Down Expand Up @@ -241,7 +243,7 @@ <h2>Redefined variables<a class="headerlink" href="#redefined-variables" title="
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'0.7.1',
VERSION:'0.7.2',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
Expand Down

0 comments on commit 33185a6

Please sign in to comment.