Skip to content

Docs: reference example test files in README and clarify benchmark example docstring#7

Merged
Code0x58 merged 1 commit into
masterfrom
codex/add-tests-for-alternatives.measure-correctness
May 9, 2026
Merged

Docs: reference example test files in README and clarify benchmark example docstring#7
Code0x58 merged 1 commit into
masterfrom
codex/add-tests-for-alternatives.measure-correctness

Conversation

@Code0x58
Copy link
Copy Markdown
Owner

@Code0x58 Code0x58 commented May 9, 2026

Motivation

  • Improve documentation discoverability by pointing to concrete example tests for measurement, equivalence, and benchmarking instead of a TODO placeholder.

Description

  • Replace the README TODO with a pointer to examples/test_measure.py, examples/test_equivalence.py, and examples/test_benchmark.py, and update the benchmark example docstring in examples/test_benchmark.py to clarify it uses the pytest-benchmark fixture.

Testing

  • Ran the benchmark example with pytest examples/test_benchmark.py -q and it completed successfully.

Codex Task

@codecov
Copy link
Copy Markdown

codecov Bot commented May 9, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (2b32a61) to head (e49714f).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff            @@
##            master        #7   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            1         1           
  Lines          189       189           
=========================================
  Hits           189       189           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Code0x58 Code0x58 merged commit 868175b into master May 9, 2026
5 checks passed
@Code0x58 Code0x58 deleted the codex/add-tests-for-alternatives.measure-correctness branch May 9, 2026 08:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant