Document nested withCycles behavior and recommended patterns#26
Merged
Document nested withCycles behavior and recommended patterns#26
Conversation
Add section explaining that nested withCycles calls create independent reservations that deduct budget separately. Recommend placing the guard at the outermost entry point only. Related to runcycles/cycles-spring-boot-starter#29 https://claude.ai/code/session_012fx4F3BKF7QHZ5WMN1Jaua
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
2 participants
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
Added documentation to the README explaining the behavior and gotchas of nested
withCyclescalls, along with recommended patterns to avoid budget double-counting.Changes
withCyclesCalls" section to README documenting:withCyclescalls are allowed but create independent reservationswithCyclesonly at the outermost entry pointDetails
This documentation clarifies an important behavioral characteristic that users should be aware of when using
withCyclesin nested function calls. The guidance helps prevent unexpected budget exhaustion and encourages a cleaner architecture where cycle guards are applied at system boundaries rather than throughout the call stack.https://claude.ai/code/session_012fx4F3BKF7QHZ5WMN1Jaua