summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSylvain Th?nault <sylvain.thenault@logilab.fr>2013-09-25 11:25:22 +0200
committerSylvain Th?nault <sylvain.thenault@logilab.fr>2013-09-25 11:25:22 +0200
commit8cfc7f6be64bc107beea841f61680c7111d3d9bf (patch)
tree188202539d46293dcb9ba466417903921a3d7d66 /doc
parent167ff3b05c74fd646eee682168c2160959e103bb (diff)
downloadpylint-8cfc7f6be64bc107beea841f61680c7111d3d9bf.tar.gz
fix some reST compilation pb
Diffstat (limited to 'doc')
-rw-r--r--doc/contribute.rst2
-rw-r--r--doc/run.rst17
2 files changed, 10 insertions, 9 deletions
diff --git a/doc/contribute.rst b/doc/contribute.rst
index 2468933..6a45dea 100644
--- a/doc/contribute.rst
+++ b/doc/contribute.rst
@@ -135,7 +135,7 @@ sorted. E.g on Unix system, you may generate it using::
Also, here are a few naming convention which are used:
-* Python files starting with 'func_noerror_' don't have any message file
+* Python files starting with 'func_noerror' don't have any message file
associated as they are expected to provide no output at all
* You may provide different input files (and associated output) depending on the
diff --git a/doc/run.rst b/doc/run.rst
index 5a9085b..4b0ccfa 100644
--- a/doc/run.rst
+++ b/doc/run.rst
@@ -97,13 +97,14 @@ hand tune the configuration.
Other useful global options include:
---ignore=file Add <file> (may be a directory) to the black
- list. It should be a base name, not a path.
- You may set this option multiple times.
---persistent=y_or_n Pickle collected data for later comparisons.
---output-format=<format> Select output format (text, html, custom).
---msg-template=<template> Modifiy text output message template.
---list-msgs Generate pylint's messages.
---full-documentation Generate pylint's full documentation, in reST format.
+--ignore=file Add <file> (may be a directory) to the black
+ list. It should be a base name, not a path.
+ You may set this option multiple times.
+--persistent=y_or_n Pickle collected data for later comparisons.
+--output-format=<format> Select output format (text, html, custom).
+--msg-template=<template> Modifiy text output message template.
+--list-msgs Generate pylint's messages.
+--full-documentation Generate pylint's full documentation, in reST
+ format.