Skip to content

docs(runtime): remove stale tombstone default claim - #9747

Closed
proggeramlug wants to merge 2 commits into
mainfrom
fix/9115-tombstone-default-doc
Closed

docs(runtime): remove stale tombstone default claim#9747
proggeramlug wants to merge 2 commits into
mainfrom
fix/9115-tombstone-default-doc

Conversation

@proggeramlug

@proggeramlug proggeramlug commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

The object tombstone-delete gate is enabled by default, but its doc comment still claimed it was off. Remove that stale claim and point readers to the default and rationale beside the actual environment parsing, as requested in #9115.

This changes comments only. Validated with rustfmt --check, scripts/check_file_size.sh, and git diff --check; inspected the diff to confirm the gate behavior is untouched. No version bump.

Fixes #9115.

Summary by CodeRabbit

  • Documentation
    • Clarified the documentation for object tombstone deletion behavior.
    • Removed an outdated statement describing the feature as disabled by default.
    • Directed readers to the environment configuration parsing documentation for current default behavior and rationale.
    • Added a changelog entry describing the documentation correction.

@coderabbitai

coderabbitai Bot commented Sep 4, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Team

Run ID: 92953f29-6761-41ef-8098-76e92c932ab1

📥 Commits

Reviewing files that changed from the base of the PR and between 12efed1 and 2bc0783.

📒 Files selected for processing (2)
  • changelog.d/9747-tombstone-default-comment.md
  • crates/perry-runtime/src/object/delete_rest.rs

Included review availability: Your plan provides up to 8 included reviews per hour; 6 remain after this review.


📝 Walkthrough

Walkthrough

The change removes an outdated default-OFF statement from the tombstone-delete gate documentation and adds a changelog entry. The environment-parsing logic remains the documented source for the default and rationale.

Changes

Tombstone documentation alignment

Layer / File(s) Summary
Align tombstone default documentation
crates/perry-runtime/src/object/delete_rest.rs, changelog.d/9747-tombstone-default-comment.md
The gate comment no longer states that tombstone deletes are default off. It references the environment-parsing logic, and the changelog records the correction.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 2bc07

This corrects stale tombstone-delete documentation and adds a matching changelog note without changing runtime behavior. No merge-readiness risk remains.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the primary change: removing the stale tombstone default claim from runtime documentation.
Description check ✅ Passed The description provides the change summary, rationale, linked issue, validation steps, behavior-impact statement, and version-bump status. It omits the template headings and checklist details, but th…
Linked Issues check ✅ Passed The changes satisfy issue [#9115]. They remove the contradictory default claim, direct readers to the environment-parsing logic, preserve the accurate default and kill-switch explanation, and leave be…
Out of Scope Changes check ✅ Passed The changelog entry and runtime comment update are directly related to correcting the stale tombstone-delete documentation. No unrelated code or behavior changes are present.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 2 functions across 1 files. (1 skipped: 1 …
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/9115-tombstone-default-doc

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

Comment @coderabbitai help to get the list of available commands.

@proggeramlug

Copy link
Copy Markdown
Contributor Author

Landed on main via merge train #9798 (rebase-merged, so your commits keep their authorship). Thanks!

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.

object_tombstone_deletes_enabled: doc comment says default OFF, code defaults ON (#6987 shape, second instance)

1 participant