Skip to content

Commit 5ad3041

Browse files
committed
docs: update copy
1 parent 188efee commit 5ad3041

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/contributing/benchmark_names.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,9 @@ As a general rule of thumb, use facets for categorical distinctions for which yo
184184

185185
The benchmark name indicates that the benchmark is measuring the performance of a method: `ndarray` (e.g., `sgemm.ndarray(...)`).
186186

187-
The method name component may be thought of as a specialized facet, which is set apart from other facets in order to allow consolidation across methods and properties, while still retaining the ability to facet across other benchmark dimensions. As a general rule of thumb, use `:<method>` only when measuring a callable or property on the package's main export; use facets for implementation strategies, backends, or conceptual groupings.
187+
The method name component may be thought of as a specialized facet, which is set apart from other facets in order to allow consolidation across methods and properties, while still retaining the ability to facet across other benchmark dimensions.
188+
189+
As a general rule of thumb, use `:<method>` only when measuring a callable or property on the package's main export; use facets for implementation strategies, backends, or conceptual groupings.
188190

189191
### Parameter-Value Pairs
190192

0 commit comments

Comments
 (0)