Skip to content

Commit

Permalink
docs: update yaml example and autocorrect detail
Browse files Browse the repository at this point in the history
  • Loading branch information
francisfuzz authored Mar 27, 2024
1 parent 6edd106 commit af48e19
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 @@ -516,10 +516,11 @@ linters:
corrector:
path: path/to/corrector_file.rb
name: I18nCorrector
i18n_load_path: path/to/translator_file.rb
i18n_load_path: config/locales/en.yml
```

This linter requires a `corrector` option. Without a `corrector` option, the strings won't be translated.
To leverage this linter's autocorrect feature, you must define the configuration for its `corrector`, such that its path, class name, and `i18n_load_path` are resolvable.

Linter-Specific Option | Description
--------------------------|---------------------------------------------------------
path | a string pointing to the path to the corrector file
Expand Down

0 comments on commit af48e19

Please sign in to comment.