Update documentation to acknowledge integer type mismatch in certain admin packets #8238
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 packets
ADMIN_PACKET_ADMIN_UPDATE_FREQUENCY
andADMIN_PACKET_ADMIN_POLL
call for an AdminUpdateType of uint16 and uint8 respectively, which doesn't make any sense.As far as I can tell looking at blame, this has been the case since day 1 of this being introduced, so changing it to be consistent across the two packet types would break literally everybody's implementations regardless of which way around you did it.
I have discussed this mismatch in IRC, and this documentation change seems to be the sanest way forward - at the very least it's a warning to those implementing these packets to watch out for.