Skip to content

Commit b2ffd31

Browse files
committed
docs: update copy
1 parent 891be89 commit b2ffd31

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/contributing/benchmark_names.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ where `[...]` indicates that the corresponding benchmark name component is optio
114114
- **base_name**: "base" name of the benchmark. In JavaScript, this is typically the name of the package in which the benchmark resides. In other languages, the base name is the name of the corresponding function name or operation being measured.
115115
- **...facet**: one or more conceptual groupings to which a benchmark belongs (_optional_). If included in a benchmark name, this component **must** be prefixed by a double colon `::`. Each facet **must** be separated by a comma. If you imagine a grouped column chart, think of this component as a means of specifying columns within a group in order to facilitate comparison between measurements having the same parameterization.
116116
- **method**: name of the method being measured (_optional_). A benchmark name **must** only specify a single method name. If included in a benchmark name, this component **must** be prefixed by a single colon `:`. This component is only relevant when measuring the performance of a method or property attached to a package's main export.
117-
- **...param=value**: one or more parameter name-value pairs. Each parameter name-value pair **must** be separated by a comma. If included in a benchmark name, this component **must** be prefixed by a single colon `:`. Parameter names **must** be unique. If you imagine a column chart, think of this component as a means of distinguishing columns, and, if you imagine a grouped column chart, think of this component as a means of distinguishing column groups.
117+
- **...param=value**: one or more parameter name-value pairs (_optional_). Each parameter name-value pair **must** be separated by a comma. If included in a benchmark name, this component **must** be prefixed by a single colon `:`. Parameter names **must** be unique. If you imagine a column chart, think of this component as a means of distinguishing columns, and, if you imagine a grouped column chart, think of this component as a means of distinguishing column groups.
118118

119119
As the character sequences `:`, `::`, `,`, and `=` have special meaning in benchmark names, components **must not** include those character sequences, as they are explicitly reserved for delineating components and sub-components (i.e., facets and parameter-value pairs).
120120

0 commit comments

Comments
 (0)