Repository navigation
docs: enumerate the harness's three missing refusals (#1143) - #1155
Conversation
Include the three harness refusals in docs/rewrite/benchmarks.md that were previously omitted: - --out naming a directory - --out whose parent cannot take a new file - --store with --backend postgres
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the
|
🦋 Changeset detectedLatest commit: 5a372e5 The changes in this PR will be included in the next version bump. This PR includes changesets to release 0 packagesWhen changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
[Low impact] This documentation-only PR appears safe to merge.
|
Description
Updates the harness refusal enumeration in
docs/rewrite/benchmarks.md(lines 324–332) to document all refusals enforced by the benchmark harness before opening a store.Specifically, adds the three harness refusals that were previously omitted:
--outnaming an existing directory instead of a file name (crates/nostream-storage/examples/bench.rs:641-646).--outwhose parent directory cannot take a new file / is not writable (bench.rs:647).--storeprovided when running with--backend postgres(bench.rs:617-626).Also adds an empty changeset (
.changeset/benchmark-refusals-list.md) to satisfy the docs-only PR requirement in CI.Related Issue
Fixes #1143
Related to #1131
Motivation and Context
The benchmark harness documentation in
docs/rewrite/benchmarks.mddescribes the harness contract and presents refusals as an enumeration. However, three reachable refusals added during the--outrework and backend separation were missing from the list. This aligns the document with the harness implementation.How Has This Been Tested?
crates/nostream-storage/examples/bench.rs.Types of changes
Checklist: