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

Port System.Threading.Tasks source comments to Docs #2312

Merged
merged 11 commits into from May 20, 2019
@@ -112,6 +112,7 @@
<summary>Initializes a new <see cref="T:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2" /> with the specified configuration.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">The <paramref name="dataflowBlockOptions" /> is <see langword="null" />.</exception>
This conversation was marked as resolved by carlossanlop

This comment has been minimized.

Copy link
@mairaw

mairaw Apr 16, 2019

Contributor

It seems that the /// comments are also missing the ArgumentException that can be thrown

This comment has been minimized.

Copy link
@carlossanlop

carlossanlop Apr 16, 2019

Author Member

I see. What would you like me to do? Can I add a completely new line directly here?

This comment has been minimized.

Copy link
@mairaw

mairaw Apr 17, 2019

Contributor

Yes you can @carlossanlop.

This conversation was marked as resolved by carlossanlop

This comment has been minimized.

Copy link
@mairaw

mairaw Apr 16, 2019

Contributor

We either say The <paramref name="dataflowBlockOptions" /> parameter is null or <paramref name="dataflowBlockOptions" /> is null

Suggested change
<exception cref="T:System.ArgumentNullException">The <paramref name="dataflowBlockOptions" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="dataflowBlockOptions" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="batchSize" /> must be positive.</exception>
This conversation was marked as resolved by carlossanlop

This comment has been minimized.

Copy link
@mairaw

mairaw Apr 16, 2019

Contributor

We usually focus on the condition of the exception not on the fix. We could say is not positive as well.

Suggested change
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="batchSize" /> must be positive.</exception>
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="batchSize" /> is less than one.</exception>
</Docs>
</Member>
<Member MemberName="BatchSize">
@@ -143,7 +143,7 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets whether ordered processing should be enforced on a block's handling of messages.</summary>
This conversation was marked as resolved by carlossanlop

This comment has been minimized.

Copy link
@mairaw

mairaw Apr 16, 2019

Contributor
Suggested change
<summary>Gets or sets whether ordered processing should be enforced on a block's handling of messages.</summary>
<summary>Gets or sets a value that indicates whether ordered processing should be enforced on a block's handling of messages.</summary>
<value>To be added.</value>
This conversation was marked as resolved by carlossanlop

This comment has been minimized.

Copy link
@mairaw

mairaw Apr 16, 2019

Contributor
Suggested change
<value>To be added.</value>
<value><see langword="true" /> if ordered processing is enforced; otherwise, <see langword="false" />.</value>
<remarks>To be added.</remarks>
</Docs>
@@ -950,6 +950,7 @@

Any methods in the source orderable partitioner return <see langword="null" />.</exception>
<related type="Article" href="https://docs.microsoft.com/previous-versions/msp-n-p/ff963552(v=pandp.10)">Parallel Loops</related>
This conversation was marked as resolved by carlossanlop

This comment has been minimized.

Copy link
@mairaw

mairaw Apr 16, 2019

Contributor

I prefer to leave the exceptions together before the links start.

Suggested change
<related type="Article" href="https://docs.microsoft.com/previous-versions/msp-n-p/ff963552(v=pandp.10)">Parallel Loops</related>
<exception cref="T:System.AggregateException">The exception that is thrown to contain an exception thrown from one of the specified delegates.</exception>
<related type="Article" href="https://docs.microsoft.com/previous-versions/msp-n-p/ff963552(v=pandp.10)">Parallel Loops</related>

This comment has been minimized.

Copy link
@mairaw

mairaw Apr 16, 2019

Contributor

This exception description though doesn't help explain why you get that exception. @stephentoub
would it be correct to say

<exception cref="T:System.AggregateException">One of the specified delegates has thrown an exception.</exception>?

This comment has been minimized.

Copy link
@carlossanlop

carlossanlop Apr 16, 2019

Author Member

Note: There were a bunch of AggregateExceptions with this same message.

This comment has been minimized.

Copy link
@mairaw

mairaw Apr 17, 2019

Contributor

Yep, I saw that. So once we confirm the text, we can just search and replace.

<exception cref="T:System.AggregateException">The exception that is thrown to contain an exception thrown from one of the specified delegates.</exception>
This conversation was marked as resolved by carlossanlop

This comment has been minimized.

Copy link
@mairaw

mairaw Apr 16, 2019

Contributor
Suggested change
<exception cref="T:System.AggregateException">The exception that is thrown to contain an exception thrown from one of the specified delegates.</exception>

This comment has been minimized.

Copy link
@carlossanlop

carlossanlop Apr 16, 2019

Author Member

Did you intend to remove this?

This comment has been minimized.

Copy link
@mairaw

mairaw Apr 17, 2019

Contributor

Yes, because I was moving this line to before the related tag,

</Docs>
</Member>
<Member MemberName="ForEach&lt;TSource&gt;">
@@ -1014,6 +1015,7 @@

The <see cref="M:System.Collections.Concurrent.Partitioner`1.GetPartitions(System.Int32)" /> method in the <paramref name="source" /> partitioner does not return the correct number of partitions.</exception>
<related type="Article" href="https://docs.microsoft.com/previous-versions/msp-n-p/ff963552(v=pandp.10)">Parallel Loops</related>
<exception cref="T:System.AggregateException">The exception that is thrown to contain an exception thrown from one of the specified delegates.</exception>
</Docs>
</Member>
<Member MemberName="ForEach&lt;TSource&gt;">
@@ -1086,6 +1088,7 @@

The <see cref="M:System.Collections.Concurrent.Partitioner`1.GetPartitions(System.Int32)" /> method in the <paramref name="source" /> partitioner does not return the correct number of partitions.</exception>
<related type="Article" href="https://docs.microsoft.com/previous-versions/msp-n-p/ff963552(v=pandp.10)">Parallel Loops</related>
<exception cref="T:System.AggregateException">The exception that is thrown to contain an exception thrown from one of the specified delegates.</exception>
</Docs>
</Member>
<Member MemberName="ForEach&lt;TSource&gt;">
@@ -1333,6 +1336,7 @@

The exception that is thrown when any methods in the <paramref name="source" /> orderable partitioner return <see langword="null" />.</exception>
<related type="Article" href="https://docs.microsoft.com/previous-versions/msp-n-p/ff963552(v=pandp.10)">Parallel Loops</related>
<exception cref="T:System.AggregateException">The exception that is thrown to contain an exception thrown from one of the specified delegates.</exception>
</Docs>
</Member>
<Member MemberName="ForEach&lt;TSource&gt;">
@@ -1400,6 +1404,7 @@

The exception that is thrown when any methods in the <paramref name="source" /> partitioner return <see langword="null" />.</exception>
<related type="Article" href="https://docs.microsoft.com/previous-versions/msp-n-p/ff963552(v=pandp.10)">Parallel Loops</related>
<exception cref="T:System.AggregateException">The exception that is thrown to contain an exception thrown from one of the specified delegates.</exception>
</Docs>
</Member>
<Member MemberName="ForEach&lt;TSource&gt;">
@@ -1467,6 +1472,7 @@

The exception that is thrown when any methods in the <paramref name="source" /> partitioner return <see langword="null" />.</exception>
<related type="Article" href="https://docs.microsoft.com/previous-versions/msp-n-p/ff963552(v=pandp.10)">Parallel Loops</related>
<exception cref="T:System.AggregateException">The exception that is thrown to contain an exception thrown from one of the specified delegates.</exception>
</Docs>
</Member>
<Member MemberName="ForEach&lt;TSource&gt;">
ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.