Download:
child 273:342482e8c76b
parent 271:f9cdd8aabcea
272:6a1027cb889f
Anton Shestakov <av6@dwimlabs.net>, Sat, 22 Jul 2017 13:34:55 +0800
docs: use one style for all file names, more metavariables

1 файлов изменено, 7 вставок(+), 7 удалений(-) [+]
README.rst file | annotate | diff | comparison | revisions
--- a/README.rst Sat Jul 22 12:55:25 2017 +0800
+++ b/README.rst Sat Jul 22 13:34:55 2017 +0800
@@ -27,7 +27,7 @@
..
-- run-tests.py - test runner, see bitbucket-pipelines.yml for some useful
+- run-tests.py - test runner, see *bitbucket-pipelines.yml* for some useful
arguments
@@ -78,8 +78,8 @@
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
- used (often named after the actual executable)
+- ``name``: determines what configuration file will be used
+ (*linters/<name>.yml*, it is often named after the actual executable)
- ``include``: a sequence of file patterns for checking
Optional parameters include:
@@ -95,15 +95,15 @@
- ``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.
+*linters/<name>.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
-already there, they are used to check various projects, including this one
+Every linter needs to be configured via *linters/<name>.yml* file. Some files
+are already there, they are used to check various projects, including this one
itself. Here's what they look like:
.. code:: yaml