Skip to content
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

Fix method signature format and clarify functional complements #6883

Merged
merged 5 commits into from
Jul 13, 2021

Conversation

adegeo
Copy link
Contributor

@adegeo adegeo commented Jul 13, 2021

Summary

Originally by @steveberdy

Edits to GC.xml (issue #6790)

This fixes the space before the parentheses in the method signature, making it comply with official formatting rules.

Edits to Enumerable.xml (issue #5152)

These fixes add the slight detail that the Take and Skip methods in System.Linq are complements given first that the enumerable is not repeatable.

Fixes #6790
Fixes #5152

steveberdy and others added 5 commits July 1, 2021 12:48
Updated according to issue #6790 to comply with official formatting standards
Specify that Take and Skip are complements when the sequences are unrepeatable
@adegeo
Copy link
Contributor Author

adegeo commented Jul 13, 2021

@eiriktsarpalis this just has the updated wording you suggested in the other PR. Please approve. Cheers!

@ghost
Copy link

ghost commented Jul 13, 2021

Tagging subscribers to this area: @eiriktsarpalis
See info in area-owners.md if you want to be subscribed.

Issue Details

Summary

Originally by @steveberdy

Edits to GC.xml (issue #6790)

This fixes the space before the parentheses in the method signature, making it comply with official formatting rules.

Edits to Enumerable.xml (issue #5152)

These fixes add the slight detail that the Take and Skip methods in System.Linq are complements given first that the enumerable is not repeatable.

Fixes #6790
Fixes #5152

Author: adegeo
Assignees: -
Labels:

area-System.Linq

Milestone: -

@eiriktsarpalis
Copy link
Member

Thanks!

@opbld30
Copy link

opbld30 commented Jul 13, 2021

Docs Build status updates of commit 45f3cac:

✅ Validation status: passed

File Status Preview URL Details
xml/System.Linq/Enumerable.xml ✅Succeeded View
xml/System/GC.xml ✅Succeeded View

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:

@adegeo adegeo merged commit 87abb6d into main Jul 13, 2021
@adegeo adegeo deleted the adegeo-6857 branch July 13, 2021 16:21
@gewarren
Copy link
Contributor

The method signature is autogenerated, so that issue will have to be fixed in our tooling, not through manual edits.

@adegeo
Copy link
Contributor Author

adegeo commented Jul 13, 2021

@gewarren where would that be?

@gewarren
Copy link
Contributor

@adegeo I think here: https://github.com/mono/api-doc-tools

@adegeo
Copy link
Contributor Author

adegeo commented Jul 13, 2021

@gewarren Oh, ha, I was thinking you meant the description needed that. I'll file a bug in that repo.

Opened mono/api-doc-tools#568

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
6 participants