Document position advancement in MemoryStream.WriteByte #11893
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.
Fixes #10163
Summary
MemoryStream.WriteByte
to clarify that the method advances the stream's position by onebyte upon successful write
Write
method for consistencyDetails
The
WriteByte()
method documentation was missing information about position advancement, which was present inthe
Write()
method documentation. This omission could confuse developers about how the stream's position changeswhen using this method.
Changes Made
Added the following clarification to the Remarks section:
This matches the documentation pattern used in
Write()
and provides developers with clear expectations aboutposition behavior.