Docs: note SetReply slot is absent on special _read keys#6264
Open
patrickwehbe wants to merge 1 commit into
Open
Docs: note SetReply slot is absent on special _read keys#6264patrickwehbe wants to merge 1 commit into
patrickwehbe wants to merge 1 commit into
Conversation
github-actions
Bot
added
is: documentation
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
1 participant
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.
What is this fixing or adding?
Fixes #5829.
The SetReply documentation listed the
slotargument unconditionally, but the server only includes it when the SetReply is triggered by a clientSetpacket (theSethandler inMultiServer.py). The server-generated SetReplies for the special_read_hints_{team}_{slot}and_read_client_status_{team}_{slot}keys — sent fromon_changed_hintsandon_client_status_change— do not includeslot(nororiginal_value).This mirrors the caveat already documented on the
original_valuerow, keeping the two entries consistent.How was this tested?
Documentation-only change. Verified against
MultiServer.pyonmain:slotis set only in theSetcommand handler and is not added in theon_changed_hints/on_client_status_changebroadcast paths, so it is absent for the_read_-prefixed special keys (same asoriginal_value). No code paths are affected.