Skip to content

Correct the claim that there is no unschedule - #93

Merged
cardmagic merged 2 commits into
mainfrom
docs/reminder-cancellation
Oct 15, 2026
Merged

cardmagic merged 2 commits into
mainfrom
docs/reminder-cancellation

Conversation

@cardmagic

Copy link
Copy Markdown
Owner

Summary

docs/reminders.md said "Solid Objects has no unschedule". The gem has unschedule(operation_or_handle, key:) and unschedule_all(operation) (lib/solid_objects/actor.rb), and test/integration/reminder_cancellation_test.rb covers them. An agent that read the guide was told that a Rails reminder cannot be cancelled.

Changes

  • docs/reminders.md: a new section "Cancel a reminder". Each statement in it has a test in reminder_cancellation_test.rb: cancel by operation, key, or handle; unschedule_all; a failed turn cancels nothing; an absent reminder is not an error; an unknown operation raises.
  • docs/agents.md: the rules show unschedule(:expire, key: buyer), and the mistakes table lists a guessed cancel method.
  • test/unit/reminder_documents_test.rb: fails when the reminder guide does not name a public reminder method of an actor, or denies one.
  • CHANGELOG.md: an Unreleased entry.

Compatibility

Documentation and a test only. No code change.

Validation

  • The three new tests failed before the change and pass after it.
  • bundle exec rake: 961 runs, 0 failures. RuboCop and Steep pass.

docs/reminders.md said "Solid Objects has no unschedule". The gem has
had unschedule and unschedule_all since reminder cancellation was
added, and the tests cover them. An agent that read the guide was told
that a Rails reminder cannot be cancelled.

The guide now has a section on how to cancel a reminder: by operation,
by key, or by handle, with the facts that the tests prove. The agent
guide shows the cancel call and lists a guessed cancel method as a
mistake. A new test fails when the reminder guide does not name a
public reminder method of an actor, or denies one.
@context7

context7 Bot commented Oct 15, 2026 •

Copy link
Copy Markdown

Docs7 for cardmagic/solid-objects-ruby

Result Status Action
Deployment ➖ Not used —
Content review ➖ Did not run. This site has no agent runs available this month. Wait for the monthly reset or check your Docs7 plan. —

Commit 908e5ba

@greptile-apps

greptile-apps Bot commented Oct 15, 2026 •

Copy link
Copy Markdown

RetriggerView in GreptileConfidence Score: 5/5

[Low impact] The PR appears safe to merge; the previous test issue is fixed and no new actionable issues were found.

Summary

Corrects the reminder cancellation guide and adds tests that check the documented methods.

  • Actor authors can now find clear instructions for cancelling reminders.

Reviews (2) · Last reviewed commit: "test: require each reminder method name ..." · Reviewed by Greptile

Comment thread test/unit/reminder_documents_test.rb Outdated
The check searched for an opening backtick and the name, so unschedule_all also satisfied unschedule, and reminders satisfied reminder. The check now includes the closing backtick.
@cardmagic

Copy link
Copy Markdown
Owner Author

@greptileai Please review the current head 908e5ba. The check now includes the closing backtick, so each reminder method needs its own mention in the guide. The test passes.

@cardmagic
cardmagic merged commit 1f94856 into main Oct 15, 2026
64 of 65 checks passed
@cardmagic
cardmagic deleted the docs/reminder-cancellation branch October 15, 2026 02:41
@cardmagic cardmagic mentioned this pull request Oct 15, 2026
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