fix: correct RoleGranted event documentation for existing members #6036
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.
The comment for the
RoleGrantedevent incorrectly stated that for existingmembers, the
sinceparameter indicates "the execution delay", when in factit represents the timestamp when the execution delay update takes effect.
This correction aligns the documentation with:
Delay.withUpdate() returning an effect timestamp
sinceequals the timestamp when the delay updatebecomes effective (grantTimestamp + setback)
TargetAdminDelayUpdated) where
sinceclearly indicates a timestampThis fixes potential confusion for developers interpreting the event parameters.