Skip to content

Commit

Permalink
Fix readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
Denis Krivak committed Apr 25, 2021
1 parent eb423f6 commit c37660d
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Expand Up @@ -28,15 +28,16 @@ or download binary from [releases page](https://github.com/tetafro/godot/release

## Config

You can specify options using config file. If no config provided the following
You can specify options using config file. Use default name `.godot.yaml`, or
set it using `-c filename.yaml` argument. If no config provided the following
defaults are used:

```yaml
# Which comments to check:
# declarations - for top level declaration comments (default);
# toplevel - for top level comments;
# all - for all comments.
scope: toplevel
scope: declarations

# List pf regexps for excluding particular comment lines from check.
exclude:
Expand Down

0 comments on commit c37660d

Please sign in to comment.