Download:
child 211:de362234c827
parent 209:8967fb24fd78
210:6355db5628d6
Anton Shestakov <av6@dwimlabs.net>, Tue, 23 Aug 2016 00:58:23 +0800
docs: emphasis on terms/filenames (`things` is interpreted as a quotation!?)

1 файлов изменено, 10 вставок(+), 9 удалений(-) [+]
README.rst file | annotate | diff | comparison | revisions
--- a/README.rst Mon Aug 22 23:05:40 2016 +0800
+++ b/README.rst Tue Aug 23 00:58:23 2016 +0800
@@ -6,7 +6,7 @@
Project configuration
=====================
-Here's an example similar to `candolint.yml` of this project itself:
+Here's an example similar to *candolint.yml* of this project itself:
.. code:: yaml
@@ -40,7 +40,7 @@
URL and SCM.
If you use push hooks or polling, this data is already present in the payload.
-You only need to put it in `projects/<name>.yml` file on the worker if you want
+You only need to put it in *projects/<name>.yml* file on the worker if you want
to run checks manually (e.g. for testing).
@@ -50,7 +50,7 @@
This is the list of linters to run on project source code. Each item only
requires two parameters:
-- ``name``: determines what configuration file from `linters/*.yml` will be
+- ``name``: determines what configuration file from *linters/\*.yml* will be
used (often named after the actual executable)
- ``include``: a sequence of file patterns for checking
@@ -59,21 +59,22 @@
- ``vars``: variables used for installing and running linters (e.g.
``python_version``)
- ``codes``: allowed exit codes (by default ``0`` and ``1`` are allowed); note
- that this is only for the actual checking, so if `linter --version` exits
+ that this is only for the actual checking, so if *linter --version* exits
with code ``1``, it's considered a failure
- ``exclude``: a sequence of file patterns to exclude from checks
- ``flags``: additional command line flags passed to the linter (before passing
file path)
- ``post_flags``: like ``flags``, but passed after file path
-The exact base command executed for each linter is specified in `linters/*.yml`
-and cannot be modified in project configuration file, see the next section.
+The exact base command executed for each linter is specified in
+*linters/\*.yml* and cannot be modified in project configuration file, see the
+next section.
Base linter configuration
=========================
-Every linter needs to be configured via `linters/*.yml` file. Some files are
+Every linter needs to be configured via *linters/\*.yml* file. Some files are
already there, they are used to check various projects, including this one
itself. Here's what they look like:
@@ -91,8 +92,8 @@
Required parameters:
-- ``exec``: a list of strings that will be fed to `subprocess.Popen` for
- running this linter
+- ``exec``: a list of strings that will be fed to Python's ``subprocess.Popen``
+ for running this linter
- ``version``: a list of strings that will be used as command line flags for
testing that this linter works after installation