Repository navigation
fix(streaming): document NotInitialized guard on upgrade() closes #462 - #640
Merged
Austinaminu2 merged 1 commit intoAug 27, 2026
Conversation
…wwStar#462 upgrade() already uses .ok_or(StreamError::NotInitialized)? consistent with pause/unpause/migrate, but lacked doc comments to make the error contract explicit. Added # Errors section to the upgrade() doc comment listing both NotInitialized and Unauthorized return variants.
|
@joshfatoye0011-bit Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
joshfatoye0011-bit
had a problem deploying
to
staging
August 26, 2026 23:41 — with 
GitHub Actions
Failure
GitHub Actions
Failure
This branch had an error being deployed
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 Closes #462 upgrade() was already using .ok_or(StreamError::NotInitialized)? — consistent with pause(), unpause(), and migrate() — but the function doc comment didn't document the error variants it can return, making the contract implicit. ## Changes - Added a # Errors section to the upgrade() doc comment in contracts/streaming/src/lib.rs explicitly listing: - StreamError::NotInitialized — contract has not been initialized yet - StreamError::Unauthorized — caller does not match the stored admin ## Testing No logic changes. The error behaviour was already correct; this commit makes it explicit in the public API docs.