Skip to content

Commit c0310d2

Browse files
authored
Mention -C and --config flags in Readme (HunterMcGushion#88)
* Mention `-C` and `--config` flags in Readme * Update README.md
1 parent 080aa87 commit c0310d2

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,10 @@ docstr-coverage some_project/src
108108
- _--help, -h_ - Display CLI options
109109

110110
#### Config File
111-
All options can be saved in a config file named `.docstr.yaml`
112-
example:
111+
All options can be saved in a config file. A file named `.docstr.yaml` in the folder in which `docstr-coverage` is executed is picked up automatically.
112+
Other locations can be passed using `docstr-coverage -C path/to/config.json` or the long version `--config`.
113+
114+
Example:
113115
```yaml
114116
paths: # list or string
115117
- docstr_coverage

0 commit comments

Comments
 (0)