The README describes how maskReason is encoded, but what's written is not correct. This is due to a misunderstanding of NotMasked as being bit 0. NotMasked is instead a convenience alias to set the maskReason when a channel isn't masked.
This PR corrects the information provided by the README.
Types of changes
[x] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)
Motivation and Context
Better not have mistakes in the documentation.
How Has This Been Tested?
Not relevant.
Checklist:
[x] My code follows the code style of this project.
[ ] My change requires a change to the documentation.
Description
The README describes how
maskReasonis encoded, but what's written is not correct. This is due to a misunderstanding ofNotMaskedas being bit 0.NotMaskedis instead a convenience alias to set themaskReasonwhen a channel isn't masked.This PR corrects the information provided by the README.
Types of changes
Motivation and Context
Better not have mistakes in the documentation.
How Has This Been Tested?
Not relevant.
Checklist: