Skip to content

Commit 53bb20d

Browse files
authored
docs: clarify version discrepancy note/pitfall threshold examples
1 parent 3534d07 commit 53bb20d

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

docs/usage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ poetry run rsmetacheck --input repositories.json \
6262

6363
### Version Discrepancy Notes
6464

65-
When a metadata version differs from the release version only slightly (every component differs by less than 2, e.g. `0.4.3.dev1` vs `0.4.2`), RSMetaCheck records a **note** instead of a full pitfall. Notes are only written when `--notes-output` is provided:
65+
When a metadata version differs from the release version only slightly (every component differs by less than 2, e.g. `0.4.3.dev1` vs `0.4.2` — the pre-release suffix means it is numerically close), RSMetaCheck records a **note** instead of a full pitfall. Notes are only written when `--notes-output` is provided:
6666

6767
```bash
6868
poetry run rsmetacheck --input https://github.com/example/repo --notes-output ./notes.json
@@ -84,7 +84,7 @@ Example notes file:
8484
}
8585
```
8686

87-
When the difference is significant (any component differs by 2 or more, e.g. `0.12.4` vs `0.12.1`), the issue is still reported as a pitfall regardless.
87+
When the difference is significant (any component differs by 2 or more, e.g. `0.12.3` vs `0.12.1`), the issue is still reported as a pitfall regardless.
8888

8989
### Skip SoMEF and Analyze Existing Outputs
9090

0 commit comments

Comments
 (0)