Skip to content

Fix README examples and clarify transaction guarantees - #20

Merged
Code0x58 merged 1 commit into
masterfrom
codex/executable-documentation
Oct 18, 2026
Merged

Code0x58 merged 1 commit into
masterfrom
codex/executable-documentation

Conversation

@Code0x58

@Code0x58 Code0x58 commented Oct 18, 2026 •

Copy link
Copy Markdown
Owner

README examples consistently use executable Python, import JsonStore, and assign through store rather than the undefined self. The text explains copy semantics, path access, formatting, deferred commits, and the limits of transactions with fewer words.

Validation: All three Python blocks execute successfully in order in a temporary directory; strict reStructuredText parsing and the 35-test suite pass.

Stack position 7 of 9. Depends on #19; this PR targets codex/rollback-failed-commits so its diff contains only this fix. Addresses review finding 9.

Stack overview: #14. Next: #21.

@codecov

codecov Bot commented Oct 18, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.77%. Comparing base (07eb56e) to head (ae843f7).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##           master      #20   +/-   ##
=======================================
  Coverage   98.77%   98.77%           
=======================================
  Files           1        1           
  Lines         163      163           
=======================================
  Hits          161      161           
  Misses          2        2           

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

@Code0x58
Code0x58 force-pushed the codex/executable-documentation branch from aa3013d to 727ac32 Compare October 18, 2026 15:13
@Code0x58
Code0x58 added this pull request to stack #23 October 18, 2026 15:39
@Code0x58
Code0x58 force-pushed the codex/executable-documentation branch 5 times, most recently from 155525b to f1f7c38 Compare October 18, 2026 15:47
Base automatically changed from codex/rollback-failed-commits to master October 18, 2026 15:47
@Code0x58
Code0x58 force-pushed the codex/executable-documentation branch from f1f7c38 to ae843f7 Compare October 18, 2026 15:47
@Code0x58
Code0x58 merged commit 4a0c42f into master Oct 18, 2026
19 checks passed
@Code0x58
Code0x58 deleted the codex/executable-documentation branch October 18, 2026 18:49
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