Skip to content

Update TextSpan.cs#57300

Merged
RikkiGibson merged 2 commits intodotnet:mainfrom
MarcioAB:patch-1
Oct 27, 2021
Merged

Update TextSpan.cs#57300
RikkiGibson merged 2 commits intodotnet:mainfrom
MarcioAB:patch-1

Conversation

@MarcioAB
Copy link
Copy Markdown
Contributor

@MarcioAB MarcioAB commented Oct 21, 2021

Resolves #57299

Currently the documentation of Microsoft.CodeAnalysis.Text.TextSpan.ToString() is only "Provides a string representation for TextSpan."
I propose to include the following text to improve understanding:
"This representation uses "half-open interval" notation, indicating the endpoint character is not included.
Example: [10..20), indicating the text starts at position 10 and ends at position 20 not included."

Currently the documentation of Microsoft.CodeAnalysis.Text.TextSpan.ToString() is only "Provides a string representation for TextSpan."
I propose to include the following text to improve understanding:
"This representation uses "half-open interval" notation, indicating the endpoint character is not included.
Example: [10..20), indicating the text starts at position 10 and ends at position 20 not included."
@MarcioAB MarcioAB requested a review from a team as a code owner October 21, 2021 14:18
@ghost ghost added Community The pull request was submitted by a contributor who is not a Microsoft employee. Area-Compilers labels Oct 21, 2021
@RikkiGibson
Copy link
Copy Markdown
Member

Thanks for your PR @MarcioAB. I'm editing the PR description to make it reference the issue which is addressed by this PR.

Co-authored-by: Sam Harwell <sam@tunnelvisionlabs.com>
@RikkiGibson
Copy link
Copy Markdown
Member

@dotnet/roslyn-compiler for 2nd review of a doc-only change

@RikkiGibson RikkiGibson merged commit 88a945a into dotnet:main Oct 27, 2021
@ghost ghost added this to the Next milestone Oct 27, 2021
@RikkiGibson
Copy link
Copy Markdown
Member

Thanks for the contribution @MarcioAB!

@MarcioAB
Copy link
Copy Markdown
Contributor Author

Looking forward to contributing more. Thank you.

@allisonchou allisonchou modified the milestones: Next, 17.1.P2 Nov 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area-Compilers Community The pull request was submitted by a contributor who is not a Microsoft employee. Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Request for improvement of TextSpan.ToString() documentation.

7 participants