Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 055e163

Browse files
committedFeb 20, 2021
Update documentation.
1 parent 14f7e5b commit 055e163

File tree

3 files changed

+19
-19
lines changed

3 files changed

+19
-19
lines changed
 

‎docs/cli.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ Options:
4040
Specify the unit for time output. Default: auto,auto.
4141
Possible values:
4242
auto (automatically convert between milli- and microseconds)
43-
ms (milliseconds)
44-
µs (microseconds)
43+
ms|milliseconds (milliseconds)
44+
µs|microseconds (microseconds)
4545
B (bytes)
4646
KB (kilobytes)
4747
MB (megabytes)
@@ -149,12 +149,12 @@ js-profiler --unit=ms,KB # time milliseconds, memory: kilobyte
149149

150150
available units:
151151

152-
* auto (automatically convert between milli- and microseconds)
153-
* ms (milliseconds)
154-
* µs (microseconds)
155-
* B (bytes)
156-
* KB (kilobytes)
157-
* MB (megabytes)
152+
* `auto`: automatically convert between milli- and microseconds
153+
* `ms` or `milliseconds`: milliseconds
154+
* `µs` or `microseconds`: microseconds
155+
* `B`: bytes
156+
* `KB`: kilobytes
157+
* `MB`: megabytes
158158

159159
### Verbosity
160160

‎docs/js-profiler.1

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
." vim: set syn=nroff
2-
.TH js-profiler 1 "August 2020" "js-profiler v2.3.1"
2+
.TH js-profiler 1 "February 2021" "js-profiler v2.4.0"
33

44
.SH NAME
55
js-profiler - A JavaScript profiling tool and collection of profiling modules and benchmarks.
@@ -69,10 +69,10 @@ Available units:
6969
.RS
7070
.IP auto .2i
7171
automatically convert between milli- and microseconds. DEFAULT
72-
.IP ms
73-
milliseconds
74-
.IP \[u03BC]s
75-
microseconds. ATTENTION: the first letter is an actual mu.
72+
.IP ms|milliseconds
73+
milliseconds. Both the shorthand 'ms' and the long form 'milliseconds' are recognized.
74+
.IP \[u03BC]s|microseconds
75+
microseconds. Both the shorthand '\[u03BC]s' and the long form 'microseconds' are recognized.
7676
.IP B
7777
.br
7878
Byte

‎docs/lib.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -113,12 +113,12 @@ jsperformance.run({
113113

114114
Specify the unit to use for time output. Possible values are:
115115

116-
* `auto` Automatically convert between units where appropriate.
117-
* `ms` Milliseconds
118-
* `µs` Microseconds
119-
* `B` Byte
120-
* `KB` Kilobyte
121-
* `MB` Megabyte
116+
* `auto`: Automatically convert between units where appropriate.
117+
* `ms` or `milliseconds`: Milliseconds
118+
* `µs` or `microseconds`: Microseconds
119+
* `B`: Byte
120+
* `KB`: Kilobyte
121+
* `MB`: Megabyte
122122

123123
Use the constants found in [units](../lib/support/units/index.js).
124124

0 commit comments

Comments
 (0)
Please sign in to comment.