Skip to content

Commit cc0bcfd

Browse files
committed
Note error if you mix units
1 parent 0297cb7 commit cc0bcfd

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ Changing the name for an existing stat will break the pass/fail comparison until
4242

4343
A regular expression to parse the file/stdin for a specific value.
4444
There should be exactly one capture group in your regular expression (using parentheses) and you can include extra characters like a percent sign "%".
45-
The extra characters will simply be removed when comparing the values (ex. "36%" will be interpreted as "36") so be careful not to mix units like "mb" vs "gb" as they won't convert automatically (ex. "1mb" and "1gb" will both be interpreted as "1").
45+
The extra characters will simply be removed when comparing the values (ex. "36%" will be interpreted as "36").
46+
You'll receive an error if you mix units (ex. "1mb" and "1gb").
4647

4748
By default commitstat assumes the input is simply a number and a regex isn't needed (ex. `stat -f %z app.zip | commitstat -`).
4849

0 commit comments

Comments
 (0)