Skip to content

Commit 1cb8f1e

Browse files
authored
Bring back Task-related remark removals that got re-added in the last docs porting. (#8060)
Co-authored-by: carlossanlop <[email protected]>
1 parent 6435f0a commit 1cb8f1e

File tree

4 files changed

+6
-38
lines changed

4 files changed

+6
-38
lines changed

xml/System.Runtime.CompilerServices/TaskAwaiter.xml

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -61,15 +61,7 @@
6161
</Attributes>
6262
<Docs>
6363
<summary>Provides an object that waits for the completion of an asynchronous task.</summary>
64-
<remarks>
65-
<format type="text/markdown"><![CDATA[
66-
67-
## Remarks
68-
69-
This type is intended for compiler use only.
70-
71-
]]></format>
72-
</remarks>
64+
<remarks>To be added.</remarks>
7365
</Docs>
7466
<Members>
7567
<Member MemberName="GetResult">
@@ -116,7 +108,7 @@ This type is intended for compiler use only.
116108
<Parameters />
117109
<Docs>
118110
<summary>Ends the wait for the completion of the asynchronous task.</summary>
119-
<remarks />
111+
<remarks>To be added.</remarks>
120112
<exception cref="T:System.NullReferenceException">The <see cref="T:System.Runtime.CompilerServices.TaskAwaiter" /> object was not properly initialized.</exception>
121113
<exception cref="T:System.Threading.Tasks.TaskCanceledException">The task was canceled.</exception>
122114
<exception cref="T:System.Exception">The task completed in a <see cref="F:System.Threading.Tasks.TaskStatus.Faulted" /> state.</exception>

xml/System.Runtime.CompilerServices/TaskAwaiter`1.xml

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -65,15 +65,7 @@
6565
<Docs>
6666
<typeparam name="TResult">The result for the task.</typeparam>
6767
<summary>Represents an object that waits for the completion of an asynchronous task and provides a parameter for the result.</summary>
68-
<remarks>
69-
<format type="text/markdown"><![CDATA[
70-
71-
## Remarks
72-
73-
This type is intended for compiler use only.
74-
75-
]]></format>
76-
</remarks>
68+
<remarks>To be added.</remarks>
7769
</Docs>
7870
<Members>
7971
<Member MemberName="GetResult">
@@ -121,7 +113,7 @@ This type is intended for compiler use only.
121113
<Docs>
122114
<summary>Ends the wait for the completion of the asynchronous task.</summary>
123115
<returns>The result of the completed task.</returns>
124-
<remarks />
116+
<remarks>To be added.</remarks>
125117
<exception cref="T:System.NullReferenceException">The <see cref="T:System.Runtime.CompilerServices.TaskAwaiter`1" /> object was not properly initialized.</exception>
126118
<exception cref="T:System.Threading.Tasks.TaskCanceledException">The task was canceled.</exception>
127119
<exception cref="T:System.Exception">The task completed in a <see cref="F:System.Threading.Tasks.TaskStatus.Faulted" /> state.</exception>

xml/System.Threading.Tasks/Task.xml

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3114,15 +3114,7 @@ Starting in .NET 6, for some `T` types and some result values, this method may r
31143114
<Docs>
31153115
<summary>Gets an awaiter used to await this <see cref="T:System.Threading.Tasks.Task" />.</summary>
31163116
<returns>An awaiter instance.</returns>
3117-
<remarks>
3118-
<format type="text/markdown"><![CDATA[
3119-
3120-
## Remarks
3121-
3122-
This method is intended for compiler use rather than use directly in code.
3123-
3124-
]]></format>
3125-
</remarks>
3117+
<remarks>To be added.</remarks>
31263118
</Docs>
31273119
</Member>
31283120
<Member MemberName="Id">

xml/System.Threading.Tasks/Task`1.xml

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2071,15 +2071,7 @@ For operations that do not return a value, you use the <xref:System.Threading.Ta
20712071
<Docs>
20722072
<summary>Gets an awaiter used to await this <see cref="T:System.Threading.Tasks.Task`1" />.</summary>
20732073
<returns>An awaiter instance.</returns>
2074-
<remarks>
2075-
<format type="text/markdown"><![CDATA[
2076-
2077-
## Remarks
2078-
2079-
This method is intended for compiler use rather than use directly in code.
2080-
2081-
]]></format>
2082-
</remarks>
2074+
<remarks>To be added.</remarks>
20832075
</Docs>
20842076
</Member>
20852077
<Member MemberName="Result">

0 commit comments

Comments
 (0)