Document System.Buffers.SequenceReader #2841
Conversation
carlossanlop
added
new-content
carlossanlop
requested review from
JeremyKuhne,
ahsonkhan,
layomia,
mairaw and
rpetrusha
|
The build says there was an error in SequenceReaderExtensions.xml: "Object reference not set to an instance of an object", but there is no error line and doesn't say which object. In the last table, it says the file succeeded validation. I'm not sure what happened. @rpetrusha @mairaw how do I find out what caused the error? |
|
Let's try rebuilding first (closing and reopening the PR does that). If the issue doesn't go away, we might have to file a bug. I haven't seen this issue before. |
|
The build failed with no indication of an underlying cause. Closing and reopening to start new build. |
rpetrusha
left a comment
rpetrusha
left a comment
There was a problem hiding this comment.
This looks good, @carlossanlop. I've made two minor changes to the SequenceReaderExtensions type summary. I'll merge when the build completes successfully.
rpetrusha
added
verify-build-before-merge
and removed
waiting-on-reviews
|
There are a couple of comments and suggestions from @ahsonkhan to address before we merge, @carlossanlop. |
Co-Authored-By: Ahson Khan <[email protected]>
|
All suggestions applied. If this looks good after the build finishes, can we get it merged? @rpetrusha |
|
@rpetrusha the build passed. I think it's good to merge. |
|
I'll merge it now, @carlossanlop. |
| <param name="value">To be added.</param> | ||
| <summary>To be added.</summary> | ||
| <returns>To be added.</returns> | ||
| <param name="reader">The byte sequence reader from which to read the value.</param> |
There was a problem hiding this comment.
All instance of this weren't fixed :(
| <param name="value">To be added.</param> | ||
| <summary>To be added.</summary> | ||
| <returns>To be added.</returns> | ||
| <param name="reader">The byte sequence reader instance from which the value is to be read.</param> |
There was a problem hiding this comment.
| <param name="reader">The byte sequence reader instance from which the value is to be read.</param> | |
| <param name="reader">The byte sequence reader from which to read the value.</param> |
| <summary>Reads a big-endian <see cref="T:System.Int16" />.</summary> | ||
| <returns> | ||
| <see langword="true" /> if the read operation is successful; <see langword="false" /> if there isn't enough data for an <see cref="T:System.Int16" />.</returns> | ||
| <param name="reader">The byte sequence reader instance from which the value is to be read.</param> |
There was a problem hiding this comment.
| <param name="reader">The byte sequence reader instance from which the value is to be read.</param> | |
| <param name="reader">The byte sequence reader from which to read the value.</param> |
| <param name="value">To be added.</param> | ||
| <summary>To be added.</summary> | ||
| <returns>To be added.</returns> | ||
| <param name="reader">The byte sequence reader instance from which the value is to be read.</param> |
There was a problem hiding this comment.
| <param name="reader">The byte sequence reader instance from which the value is to be read.</param> | |
| <param name="reader">The byte sequence reader from which to read the value.</param> |
| <summary>Reads a big-endian <see cref="T:System.Int32" />.</summary> | ||
| <returns> | ||
| <see langword="true" /> if the read operation is successful; <see langword="false" /> if there isn't enough data for an <see cref="T:System.Int32" />.</returns> | ||
| <param name="reader">The byte sequence reader instance from which the value is to be read.</param> |
There was a problem hiding this comment.
| <param name="reader">The byte sequence reader instance from which the value is to be read.</param> | |
| <param name="reader">The byte sequence reader from which to read the value.</param> |
| <summary>Reads a little-endian <see cref="T:System.Int16" />.</summary> | ||
| <returns> | ||
| <see langword="true" /> if the read operation is successful; <see langword="false" /> if there isn't enough data for an <see cref="T:System.Int16" />.</returns> | ||
| <param name="reader">The byte sequence reader instance from which the value is to be read.</param> |
There was a problem hiding this comment.
| <param name="reader">The byte sequence reader instance from which the value is to be read.</param> | |
| <param name="reader">The byte sequence reader from which to read the value.</param> |
6 participants
@JeremyKuhne wrote these APIs. @layomia is the main owner. @ahsonkhan is third owner.
Here's the API proposal: https://github.com/dotnet/corefx/issues/32588
Here's the PR where they were introduced: https://github.com/dotnet/corefx/pull/33288/files