Skip to content

Commit

Permalink
docs: fixed reference to old cli argument name in custom formatter do…
Browse files Browse the repository at this point in the history
…cs (#484)

[ci skip]
  • Loading branch information
Catsuko authored Apr 15, 2024
1 parent f7541e2 commit 26adfb2
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/formatters.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,12 @@ See the [Rakefile](https://github.com/MarcGrimme/repo-small-badge/blob/master/Ra

When *rubycritic* is called outside of the structure that has to be **criticized** with just calling the command.
The path to load as well, as the fully qualified classname of the formatter, have to be passed.
This happens with the `--formatter` option followed by the path to require (*requirepath*) a `:` as a separator and the fully qualified *classname*.
This happens with the `--custom-format` option followed by the path to require (*requirepath*) a `:` as a separator and the fully qualified *classname*.
An example could look as follows:

``` shell
gem install my_formatter_gem
rubycritic --formatter my_formatter:MyFormatter
rubycritic --custom-format my_formatter:MyFormatter
```

This will do the same as above.

0 comments on commit 26adfb2

Please sign in to comment.