Skip to content

docs: softDelete=false alone purges already soft-deleted rows - #4454

Merged
bpamiri merged 1 commit into
developfrom
peter/consumer-docs-purge
Oct 6, 2026
Merged

bpamiri merged 1 commit into
developfrom
peter/consumer-docs-purge

Conversation

@bpamiri

@bpamiri bpamiri commented Oct 6, 2026

Copy link
Copy Markdown
Collaborator

Since #4397 (#4371), delete() / deleteAll() / deleteOne() / deleteByKey() with softDelete=false are always real deletes, including rows that are already soft-deleted. This updates the one bullet in the consumer models.md (and its wheels new template copy) that still told readers to also pass includeSoftDeletes=true for those rows.

#4397 already added the new behaviour to the summary paragraph in the same file. This brings the soft-delete section's bullet in line with it.

tools/build/scripts/ship-consumer-docs.sh check passes, and the template copy is identical.

🤖 Generated with Claude Code

Since #4397 (#4371), includeSoftDeletes=true is no longer needed to
remove rows that are already soft-deleted.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>
@bpamiri bpamiri added this to the v4.2.0 milestone Oct 6, 2026
@bpamiri

bpamiri commented Oct 6, 2026

Copy link
Copy Markdown
Collaborator Author

Review: head 494a1a2. APPROVE (docs).

  • The new bullet matches develop since fix(model): keep soft deletes reversible and make softDelete=false a real delete #4397 (ee93247). deleteAll, deleteByKey and deleteOne set includeSoftDeletes = true when softDelete = false (delete.cfm:36,114,156), and instance delete() does the same (:205). So deleteAll(where="...", softDelete=false) alone removes rows that are already soft-deleted, and the "pass both" advice is no longer needed.
  • Both .ai/models.md copies are byte-identical.
  • I found no other place in the consumer docs, the template .ai files or the v4-2-0 guides that still says to pass includeSoftDeletes=true with softDelete=false. The spec gotcha (models.md:114) and the tutorial aside (05-comments-streams.mdx:342) are both still accurate.

The final follows PR CI.

@github-actions github-actions Bot added the docs label Oct 6, 2026
@bpamiri

bpamiri commented Oct 6, 2026

Copy link
Copy Markdown
Collaborator Author

FINAL: APPROVE. Head 494a1a2.

@bpamiri
bpamiri merged commit 29d87d0 into develop Oct 6, 2026
18 checks passed
@bpamiri
bpamiri deleted the peter/consumer-docs-purge branch October 6, 2026 01:39
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