Skip to content

Commit

Permalink
Update docs for 0.13.0 [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
mpeterv committed Jan 4, 2016
1 parent c4b0770 commit 700937e
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docsrc/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Command line interface

* Given a file, ``luacheck`` will check it.
* Given ``-``, ``luacheck`` will check stdin.
* Given a directory, ``luacheck`` will check all files with ``.lua`` extension within it. This feature requires `LuaFileSystem <http://keplerproject.github.io/luafilesystem/>`_ (installed automatically if LuaRocks was used to install Luacheck).
* Given a directory, ``luacheck`` will check all files within it, selecting only files with ``.lua`` extension unless ``--include-files`` option is used. This feature requires `LuaFileSystem <http://keplerproject.github.io/luafilesystem/>`_ (installed automatically if LuaRocks was used to install Luacheck).
* Given a rockspec (a file with ``.rockspec`` extension), ``luacheck`` will check all files with ``.lua`` extension mentioned in the rockspec in ``build.install.lua``, ``build.install.bin`` and ``build.modules`` tables.

The output of ``luacheck`` consists of separate reports for each checked file and ends with a summary::
Expand Down
3 changes: 1 addition & 2 deletions docsrc/inline.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,7 @@ For fine-grained control over inline option visibility use ``luacheck: push`` an
.. code-block:: lua
:linenos:
-- luacheck: push
-- luacheck: ignore foo
-- luacheck: push ignore foo
foo() -- No warning.
-- luacheck: pop
foo() -- Warning is emitted.
Expand Down
2 changes: 2 additions & 0 deletions docsrc/warnings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ Code Description
532 Left-hand side of an assignment is too long.
541 An empty ``do`` ``end`` block.
542 An empty ``if`` branch.
551 An empty statement.
==== =============================================

Global variables
Expand Down Expand Up @@ -140,3 +141,4 @@ The following control flow and data flow issues are detected:
* Unused labels;
* Unbalanced assignments;
* Empty blocks.
* Empty statements (semicolons without preceding statements).

0 comments on commit 700937e

Please sign in to comment.