Repository navigation
Correct the claim that there is no unschedule - #93
Merged
Merged
Conversation
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.
|
Docs7 for cardmagic/solid-objects-ruby
Commit |
[Low impact] The PR appears safe to merge; the previous test issue is fixed and no new actionable issues were found. SummaryCorrects the reminder cancellation guide and adds tests that check the documented methods.
Reviews (2) · Last reviewed commit: "test: require each reminder method name ..." · Reviewed by Greptile |
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.
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. |
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/reminders.mdsaid "Solid Objects has nounschedule". The gem hasunschedule(operation_or_handle, key:)andunschedule_all(operation)(lib/solid_objects/actor.rb), andtest/integration/reminder_cancellation_test.rbcovers 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 inreminder_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 showunschedule(: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
bundle exec rake: 961 runs, 0 failures. RuboCop and Steep pass.