Add some missing System.Text docs #7121
Conversation
|
Docs Build status updates of commit 56e250e: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
| <Parameter Name="obj" Type="System.Object" Index="0" FrameworkAlternate="net-5.0;net-6.0" /> | ||
| </Parameters> | ||
| <Docs> | ||
| <param name="other">The object to compare with the current instance.</param> |
There was a problem hiding this comment.
Weird. There's no <Parameter Name="other" ... />. Usually it would mean that the parameter got renamed between previews.
@gewarren I guess it's fine to remove it? The CI did not complain.
| <Docs> | ||
| <summary>Gets the line at the current position of the enumerator.</summary> | ||
| <value>To be added.</value> | ||
| <remarks>To be added.</remarks> |
There was a problem hiding this comment.
I don't think we're supposed to remove <remarks> items, even if they are left undocumented. The default string is To be added..
Although, I did not see any CI failures. @gewarren should these two remark lines be brought back or can they stay removed?
There was a problem hiding this comment.
It will get re-added on the next CI job, so it's probably best not to delete it.
| <Parameter Name="obj" Type="System.Object" Index="0" FrameworkAlternate="net-5.0;net-6.0" /> | ||
| </Parameters> | ||
| <Docs> | ||
| <param name="other">The object to compare with the current instance.</param> |
| <Docs> | ||
| <summary>Gets the line at the current position of the enumerator.</summary> | ||
| <value>To be added.</value> | ||
| <remarks>To be added.</remarks> |
There was a problem hiding this comment.
It will get re-added on the next CI job, so it's probably best not to delete it.
| <summary>Advances the enumerator to the next line of the span.</summary> | ||
| <returns> | ||
| <see langword="true" /> if the enumerator successfully advanced to the next line; <see langword="false" /> if the enumerator has advanced past the end of the span.</returns> | ||
| <remarks>To be added.</remarks> |
There was a problem hiding this comment.
I would undelete this one too.
|
For the The API is unremarkable. :) |
Just leave it as "To be added.". That is well-known text. Even if you never intend to add any :) |
|
Thanks @carlossanlop for re-adding them! |
|
Docs Build status updates of commit 42e9b91: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
5 participants
Summary
Add missing System.Text docs for Rune and SpanLineEnumerator. The text for
MoveNextwas copied largely fromSpan<T>+Enumerator.MoveNext.Contributes to dotnet/runtime#58665.