Skip to content
This repository was archived by the owner on Jul 19, 2025. It is now read-only.

Commit f17dc4a

Browse files
committed
update README
1 parent 72a6353 commit f17dc4a

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,12 @@ duplication, try raising the threshold. If you suspect that the engine isn't
4444
catching enough duplication, try lowering the threshold. The best setting tends
4545
to differ from language to language.
4646
47-
To adjust this setting, add a `mass_threshold` key with your preferred value for
47+
You can set thresholds for the two different types of duplication this engine
48+
reports: blocks that are identical to each other, and blocks that are
49+
structurally similar but differ in content.
50+
51+
To adjust these thresholds, you can add `identical_mass_threshold` and
52+
`similar_mass_threshold` keys with your preferred value for
4853
an enabled language:
4954

5055
```yaml
@@ -54,11 +59,15 @@ engines:
5459
config:
5560
languages:
5661
ruby:
57-
mass_threshold: 20
62+
identical_mass_threshold: 20
63+
similar_mass_threshold: 30
5864
javascript:
5965
```
6066

61-
Note that you have the update the YAML structure under the `langauges` key to
67+
If you would like to use the same threshold for both identical & similar issues,
68+
you can just set the `mass_threshold` key.
69+
70+
Note that you have to update the YAML structure under the `langauges` key to
6271
the Hash type to support extra configuration.
6372

6473
[codeclimate]: https://codeclimate.com/dashboard

0 commit comments

Comments
 (0)