Skip to content

Commit

Permalink
Update documentation of --ignoredFiles
Browse files Browse the repository at this point in the history
Fixes #22 and closes #23.

The usage of `--ignoredFiles` is slightly unintuitive, so clarify its usage exactly with usage examples.
  • Loading branch information
Nixinova committed May 30, 2023
1 parent 09f99b1 commit 8220770
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,9 @@ linguist --help
Analyse the language of all files found in a folder.
- `<folders...>`:
The folders to analyse (defaults to `./`).
- `--ignoredFiles <paths...>`:
A list of space-delimited file path globs to ignore.
- `--ignoredFiles <glob1> [[--ignoredFiles] <glob2> ...]`:
A list of file path globs to ignore.
When specifying more than one glob, this option can either be called with multiple values given (e.g., `--ignoredFiles *.txt *.json`) or be called multiple times (e.g., `--ignoredFiles *.txt --ignoredFiles *.json`). Both ways are equivalent.
- `--ignoredLanguages`:
A list of languages to ignore.
- `--categories <categories...>`:
Expand Down

0 comments on commit 8220770

Please sign in to comment.