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

Commit 7ee54d8

Browse files
committed
update README
1 parent 72a6353 commit 7ee54d8

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,9 @@ 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 reports: blocks that are identical to each other, and blocks that are structurally similar but differ in content.
48+
49+
To adjust these thresholds, you can add `identical_mass_threshold` and `similar_mass_threshold` keys with your preferred value for
4850
an enabled language:
4951

5052
```yaml
@@ -54,11 +56,14 @@ engines:
5456
config:
5557
languages:
5658
ruby:
57-
mass_threshold: 20
59+
identical_mass_threshold: 20
60+
similar_mass_threshold: 30
5861
javascript:
5962
```
6063

61-
Note that you have the update the YAML structure under the `langauges` key to
64+
If you would like to use the same threshold for both idential & similar issues, you can just set the `mass_threshold` key.
65+
66+
Note that you have to update the YAML structure under the `langauges` key to
6267
the Hash type to support extra configuration.
6368

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

0 commit comments

Comments
 (0)