Document luacheck.get_message function

mpeterv · Jul 18, 2015 · 6c1a296 · 6c1a296
1 parent b77688a
commit 6c1a296
Show file tree

Hide file tree

Showing 7 changed files with 4 additions and 1 deletion.
diff --git a/doc/.doctrees/environment.pickle b/doc/.doctrees/environment.pickle
diff --git a/doc/.doctrees/module.doctree b/doc/.doctrees/module.doctree
diff --git a/doc/_sources/module.txt b/doc/_sources/module.txt
@@ -7,6 +7,7 @@ Use ``local luacheck = require "luacheck"`` to import ``luacheck`` module. It co
 * ``luacheck.process_reports(reports, options)``: Processes array of analysis reports and applies options. ``reports[i]`` uses ``options``, ``options[i]``, ``options[i][1]``, ``options[i][2]``, ... as options, overriding each other in that order. Options table is a table with fields similar to config options; see :ref:`options`. Analysis reports with field ``fatal`` are ignored. ``process_reports`` returns final report, see :ref:`report`.
 * ``luacheck.check_strings(sources, options)``: Checks array of sources using options, returns final report. Tables with field ``fatal`` within ``sources`` array are ignored.
 * ``luacheck.check_files(files, options)``: Checks array of files using options, returns final report. Open file handles can passed instead of filenames, in which case they will be read till EOF and closed.
+* ``luacheck.get_message(issue)``: Returns a string message for an issue, see :ref:`report`.
 
 ``luacheck._VERSION`` contains Luacheck version as a string in ``MAJOR.MINOR.PATCH`` format.
 

diff --git a/doc/module.html b/doc/module.html
@@ -126,6 +126,7 @@ <h1>Luacheck module<a class="headerlink" href="#luacheck-module" title="Permalin
 <li><tt class="docutils literal"><span class="pre">luacheck.process_reports(reports,</span> <span class="pre">options)</span></tt>: Processes array of analysis reports and applies options. <tt class="docutils literal"><span class="pre">reports[i]</span></tt> uses <tt class="docutils literal"><span class="pre">options</span></tt>, <tt class="docutils literal"><span class="pre">options[i]</span></tt>, <tt class="docutils literal"><span class="pre">options[i][1]</span></tt>, <tt class="docutils literal"><span class="pre">options[i][2]</span></tt>, ... as options, overriding each other in that order. Options table is a table with fields similar to config options; see <a class="reference internal" href="config.html#options"><em>Config options</em></a>. Analysis reports with field <tt class="docutils literal"><span class="pre">fatal</span></tt> are ignored. <tt class="docutils literal"><span class="pre">process_reports</span></tt> returns final report, see <a class="reference internal" href="#report"><em>Report format</em></a>.</li>
 <li><tt class="docutils literal"><span class="pre">luacheck.check_strings(sources,</span> <span class="pre">options)</span></tt>: Checks array of sources using options, returns final report. Tables with field <tt class="docutils literal"><span class="pre">fatal</span></tt> within <tt class="docutils literal"><span class="pre">sources</span></tt> array are ignored.</li>
 <li><tt class="docutils literal"><span class="pre">luacheck.check_files(files,</span> <span class="pre">options)</span></tt>: Checks array of files using options, returns final report. Open file handles can passed instead of filenames, in which case they will be read till EOF and closed.</li>
+<li><tt class="docutils literal"><span class="pre">luacheck.get_message(issue)</span></tt>: Returns a string message for an issue, see <a class="reference internal" href="#report"><em>Report format</em></a>.</li>
 </ul>
 <p><tt class="docutils literal"><span class="pre">luacheck._VERSION</span></tt> contains Luacheck version as a string in <tt class="docutils literal"><span class="pre">MAJOR.MINOR.PATCH</span></tt> format.</p>
 <p>Using <tt class="docutils literal"><span class="pre">luacheck</span></tt> as a function is equivalent to calling <tt class="docutils literal"><span class="pre">luacheck.check_files</span></tt>.</p>

diff --git a/doc/objects.inv b/doc/objects.inv
diff --git a/doc/searchindex.js b/doc/searchindex.js
diff --git a/docsrc/module.rst b/docsrc/module.rst
@@ -7,6 +7,7 @@ Use ``local luacheck = require "luacheck"`` to import ``luacheck`` module. It co
 * ``luacheck.process_reports(reports, options)``: Processes array of analysis reports and applies options. ``reports[i]`` uses ``options``, ``options[i]``, ``options[i][1]``, ``options[i][2]``, ... as options, overriding each other in that order. Options table is a table with fields similar to config options; see :ref:`options`. Analysis reports with field ``fatal`` are ignored. ``process_reports`` returns final report, see :ref:`report`.
 * ``luacheck.check_strings(sources, options)``: Checks array of sources using options, returns final report. Tables with field ``fatal`` within ``sources`` array are ignored.
 * ``luacheck.check_files(files, options)``: Checks array of files using options, returns final report. Open file handles can passed instead of filenames, in which case they will be read till EOF and closed.
+* ``luacheck.get_message(issue)``: Returns a string message for an issue, see :ref:`report`.
 
 ``luacheck._VERSION`` contains Luacheck version as a string in ``MAJOR.MINOR.PATCH`` format.