Skip to content

docs: enumerate the harness's three missing refusals (#1143) - #1155

Merged
avantikonde merged 1 commit into
factory/030-benchmark-rigfrom
fix/1143-benchmark-refusal-list
Nov 16, 2026
Merged

avantikonde merged 1 commit into
factory/030-benchmark-rigfrom
fix/1143-benchmark-refusal-list

Conversation

@avantikonde

Copy link
Copy Markdown
Collaborator

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:

  1. --out naming an existing directory instead of a file name (crates/nostream-storage/examples/bench.rs:641-646).
  2. --out whose parent directory cannot take a new file / is not writable (bench.rs:647).
  3. --store provided 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.md describes the harness contract and presents refusals as an enumeration. However, three reachable refusals added during the --out rework and backend separation were missing from the list. This aligns the document with the harness implementation.

How Has This Been Tested?

  • Verified the wording against the refusal implementations and tests in crates/nostream-storage/examples/bench.rs.
  • Checked markdown line wrapping and document style consistency.

Types of changes

  • Non-functional change (docs, style, minor refactor)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my code changes.
  • I added a changeset, or this is docs-only and I added an empty changeset.
  • All new and existing tests passed.

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
@coderabbitai

coderabbitai Bot commented Nov 16, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 05320587-0d02-4c22-9877-c6d1a9ba0d76

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • Trigger review
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@changeset-bot

changeset-bot Bot commented Nov 16, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 5a372e5

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

When 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

@greptile-apps

greptile-apps Bot commented Nov 16, 2026 •

Copy link
Copy Markdown

RetriggerView in GreptileConfidence Score: 5/5

[Low impact] This documentation-only PR appears safe to merge.

Summary

Updates docs/rewrite/benchmarks.md to list three existing refusals:

  • Benchmark docs list all three missing pre-run refusals.

The descriptions match the harness code. No actionable issues found.

Reviews (1) · Last reviewed commit: "docs: enumerate the harness's three miss..." · Reviewed by Greptile

@avantikonde
avantikonde merged commit ccb96fe into factory/030-benchmark-rig Nov 16, 2026
17 checks passed
@avantikonde
avantikonde deleted the fix/1143-benchmark-refusal-list branch November 16, 2026 07:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant