docs

davidhyman · davidhyman · commit 69b98dbc1fac · 2018-06-12T12:33:40.000+01:00
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -33,7 +33,7 @@ jobs:
             python3 -m venv venv
             . venv/bin/activate
             pip install -e .
-            pip install green
+            pip install green flake8
 
       - save_cache:
           paths:
@@ -51,6 +51,12 @@ jobs:
             . venv/bin/activate
             green
 
+      - run:
+          name: run static analysis
+          command: |
+            . venv/bin/activate
+            flake8
+
       - store_artifacts:
           path: test-reports
           destination: test-reports
diff --git a/README.md b/README.md
@@ -42,8 +42,8 @@ Then:
 `pip install -e path/to/snippet`
 
 ## configure
-Place a `.toml` [configuration file](https://github.com/toml-lang/toml)
-in your project directory. Any value defined in [the config object](https://github.com/ARMmbed/snippet/blob/22cb8b4af961b8c728ab6f4d9b91922823c6620f/src/snippet/config.py#L8) 
+Place a config file in the [toml format](https://github.com/toml-lang/toml)
+in your project directory (e.g. `snippet.toml`). Any value defined in [the config object](https://github.com/ARMmbed/snippet/blob/master/src/snippet/config.py#L8)
 can be overridden.
 
 As an example, basic configuration typically includes input and output directories:
@@ -65,19 +65,22 @@ Alternatively, run snippet from anywhere and specify a working directory and con
 ```
 python -m snippet path/to/root --config=path/to/config.toml
 ```
+Config files can be specified as glob patterns, defaulting to `*.toml`, and can
+be set multiple times. Multiple files will be loaded in the order specified
+and discovered. Settings loaded last will take precedence.
 
 The full CLI options are:
 ```
 > python -m snippet --help
 usage: __main__.py [-h] [--config CONFIG] [-v] [dir]
 
 positional arguments:
-  dir              path to project root, used by relative paths in config
-                   [cwd]
+  dir              path to project root, used by any relative paths in loaded
+                   configs [cwd]
 
 optional arguments:
   -h, --help       show this help message and exit
-  --config CONFIG  path to config file
+  --config CONFIG  paths (or globs) to config files
   -v, --verbosity  increase output verbosity
 ```
 
@@ -160,13 +163,13 @@ for item in items:
 ```
 
 ## validation
-Because `snippet` is language-agnostic it is also unlikely that an
+Because `snippet` is language-agnostic it is unlikely that an
 IDE would detect invalid snippets, or changes to code that may break them.
 
 `snippet` can be configured to validate snippets to avoid the syntax from
 introducing bizarre broken documentation to your users. That said, it can't
 do everything - and it's still wise to QA your docs from time to time.
 Some of the checks include:
-- Tag open / close matches (can't nest examples or cloaks)
+- Tag open / close matches (avoiding nested examples or cloaks)
 - Examples left unterminated
 - Indents reducing beyond the start level for the current example
diff --git a/tests/test_config.py b/tests/test_config.py
@@ -24,10 +24,10 @@ def setUpClass(cls):
             [snippet]
             # an example: this config is itself an example
             input_glob = 'does not match anything'
-            
+
             stop_on_first_failure = true
             end_flag = 'custom value'
-            
+
             foo = 'bar'
             fizz = 'buzz'
             """).lstrip())
