Skip to content

recover dropped content + edits #3159

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 10, 2019
Merged

recover dropped content + edits #3159

merged 2 commits into from
Sep 10, 2019

Conversation

mairaw
Copy link
Contributor

@mairaw mairaw commented Sep 10, 2019

PR #3055 somehow dropped this content

Recovering that + removing we from the remarks text

@mairaw mairaw added this to the September 2019 milestone Sep 10, 2019
@mairaw mairaw self-assigned this Sep 10, 2019
@@ -270,16 +270,18 @@
<Docs>
<param name="length">The length of the collection that the range will be used with. <paramref name="length" /> has to be a positive value.</param>
Copy link
Contributor

@ahsonkhan ahsonkhan Sep 10, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From #2729, the wording was modified:

https://github.com/dotnet/dotnet-api-docs/pull/2729/files#diff-329e2957d7afa212df1c2d8a57ae415aR266

i.e.
https://github.com/carlossanlop/dotnet-api-docs/blob/acbc62c141fcdcd210f630f019edf198a6d5a48d/xml/System/Range.xml#L265-L281

      <Docs>
        <param name="length">A positive integer that represents the length of the collection that the range will be used with.</param>
        <summary>Returns a <see cref="T:System.Range.OffsetAndLength" /> instance with the starting offset and length of a range.</summary>
        <returns>The starting offset and length of the range.</returns>
        <remarks>
          <format type="text/markdown">
            <![CDATA[
## Remarks
For performance reasons, this method does't validate `length` to ensure that it is not negative. It does ensure that `length` is within the current `Range` instance. 
            ]]>
          </format>
        </remarks>
        <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="length" /> is outside the bounds of the current range. </exception>
      </Docs>

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ahsonkhan. @rpetrusha please check which version you prefer. The old or the one in this PR which is a mix of the current + old.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer the one in the PR, which is much clearer, @mairaw.

Copy link

@rpetrusha rpetrusha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@mairaw mairaw merged commit 7d7e4c5 into master Sep 10, 2019
@mairaw mairaw deleted the mairaw-patch-3 branch September 10, 2019 18:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants