Skip to content

Commit 2aabd6b

Browse files
Copilotjeffhandley
Copilot
and
jeffhandley
authored
Fix formatting issue in OrderedDictionary<TKey,TValue> documentation (#11458)
* Initial plan for issue * Fix formatting issue in OrderedDictionary<TKey,TValue> documentation Merged two separate <para> tags into one to fix formatting issue where a single sentence was incorrectly split across two paragraphs. The sentence now correctly reads as one continuous paragraph in the documentation. Fixes lines 82-83 in OrderedDictionary`2.xml Co-authored-by: jeffhandley <[email protected]> * Fix all errant para tag formatting issues across documentation files Co-authored-by: jeffhandley <[email protected]> * Fix additional errant para tag patterns per review feedback Co-authored-by: jeffhandley <[email protected]> * Apply comprehensive para tag cleanup to TypeName.xml per review feedback Co-authored-by: jeffhandley <[email protected]> * Fix indentation in TypeName.xml after para tag cleanup Co-authored-by: jeffhandley <[email protected]> * Remove superfluous para tags and fix XML formatting per review feedback Co-authored-by: jeffhandley <[email protected]> * Remove unnecessary para tags and fix XML formatting per detailed review feedback Co-authored-by: jeffhandley <[email protected]> * Fix malformed XML with orphaned para tags and apply proper formatting guidelines Co-authored-by: jeffhandley <[email protected]> * Fix XML formatting: use 2-space indentation, add line breaks for long content, and add para tags for semantic paragraphs Co-authored-by: jeffhandley <[email protected]> * Formatting tweaks --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: jeffhandley <[email protected]> Co-authored-by: Jeff Handley <[email protected]>
1 parent 2540292 commit 2aabd6b

File tree

10 files changed

+121
-232
lines changed

10 files changed

+121
-232
lines changed

‎xml/System.Collections.Concurrent/ConcurrentDictionary`2+AlternateLookup`1.xml‎

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,7 @@
4949
<typeparam name="TValue">The type of the values in the dictionary.</typeparam>
5050
<typeparam name="TAlternateKey">The alternate type of a key for performing lookups.</typeparam>
5151
<summary>
52-
<para>Provides a type that may be used to perform operations on a <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /></para>
53-
<para>using a <typeparamref name="TAlternateKey" /> as a key instead of a <typeparamref name="TKey" />.</para>
52+
Provides a type that may be used to perform operations on a <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> using a <typeparamref name="TAlternateKey" /> as a key instead of a <typeparamref name="TKey" />.
5453
</summary>
5554
<remarks>To be added.</remarks>
5655
</Docs>
@@ -129,8 +128,7 @@
129128
<param name="key">The alternate key of the value to get or set.</param>
130129
<summary>Gets or sets the value associated with the specified alternate key.</summary>
131130
<value>
132-
<para>The value associated with the specified alternate key. If the specified alternate key is not found, a get operation throws</para>
133-
<para>a <see cref="T:System.Collections.Generic.KeyNotFoundException" />, and a set operation creates a new element with the specified key.</para>
131+
The value associated with the specified alternate key. If the specified alternate key is not found, a get operation throws a <see cref="T:System.Collections.Generic.KeyNotFoundException" />, and a set operation creates a new element with the specified key.
134132
</value>
135133
<remarks>To be added.</remarks>
136134
<exception cref="T:System.ArgumentNullException">
@@ -198,10 +196,7 @@
198196
</Parameters>
199197
<Docs>
200198
<param name="key">The alternate key of the value to get.</param>
201-
<param name="value">
202-
<para>When this method returns, contains the value associated with the specified key, if the key is found;</para>
203-
<para>otherwise, the default value for the type of the value parameter.</para>
204-
</param>
199+
<param name="value">When this method returns, contains the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter.</param>
205200
<summary>Gets the value associated with the specified alternate key.</summary>
206201
<returns>
207202
<see langword="true" /> if an entry was found; otherwise, <see langword="false" />.</returns>
@@ -248,12 +243,11 @@
248243
<Docs>
249244
<param name="key">The alternate key of the value to get.</param>
250245
<param name="actualKey">
251-
<para>When this method returns, contains the actual key associated with the alternate key, if the key is found;</para>
252-
<para>otherwise, the default value for the type of the key parameter.</para>
246+
When this method returns, contains the actual key associated with the alternate key, if the key is found;
247+
otherwise, the default value for the type of the key parameter.
253248
</param>
254249
<param name="value">
255-
<para>When this method returns, contains the value associated with the specified key, if the key is found;</para>
256-
<para>otherwise, the default value for the type of the value parameter.</para>
250+
When this method returns, contains the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter.
257251
</param>
258252
<summary>Gets the value associated with the specified alternate key.</summary>
259253
<returns>
@@ -294,8 +288,9 @@
294288
<param name="key">The alternate key of the element to remove.</param>
295289
<param name="value">The removed element.</param>
296290
<summary>
297-
<para>Removes the value with the specified alternate key from the <see cref="T:System.Collections.Generic.Dictionary`2" />,</para>
298-
<para>and copies the element to the value parameter.</para>
291+
Removes the value with the specified alternate key from the
292+
<see cref="T:System.Collections.Generic.Dictionary`2" />,
293+
and copies the element to the value parameter.
299294
</summary>
300295
<returns>
301296
<see langword="true" /> if the element is successfully found and removed; otherwise, <see langword="false" />.</returns>
@@ -344,8 +339,8 @@
344339
<param name="actualKey">The removed key.</param>
345340
<param name="value">The removed element.</param>
346341
<summary>
347-
<para>Removes the value with the specified alternate key from the <see cref="T:System.Collections.Generic.Dictionary`2" />,</para>
348-
<para>and copies the associated key and element to the value parameter.</para>
342+
Removes the value with the specified alternate key from the <see cref="T:System.Collections.Generic.Dictionary`2" />,
343+
and copies the associated key and element to the value parameter.
349344
</summary>
350345
<returns>
351346
<see langword="true" /> if the element is successfully found and removed; otherwise, <see langword="false" />.</returns>

‎xml/System.Collections.Concurrent/ConcurrentDictionary`2.xml‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1011,14 +1011,12 @@
10111011
<Docs>
10121012
<typeparam name="TAlternateKey">The alternate type of a key for performing lookups.</typeparam>
10131013
<summary>
1014-
<para>Gets an instance of a type that may be used to perform operations on a <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /></para>
1015-
<para>using a <typeparamref name="TAlternateKey" /> as a key instead of a <typeparamref name="TKey" />.</para>
1014+
Gets an instance of a type that may be used to perform operations on a <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> using a <typeparamref name="TAlternateKey" /> as a key instead of a <typeparamref name="TKey" />.
10161015
</summary>
10171016
<returns>The created lookup instance.</returns>
10181017
<remarks>
1019-
<para>This instance must be using a comparer that implements <see cref="T:System.Collections.Generic.IAlternateEqualityComparer`2" /> with</para>
1020-
<para>
1021-
<typeparamref name="TAlternateKey" /> and <typeparamref name="TKey" />. If it doesn't, an exception will be thrown.</para>
1018+
This instance must be using a comparer that implements <see cref="T:System.Collections.Generic.IAlternateEqualityComparer`2" /> with
1019+
<typeparamref name="TAlternateKey" /> and <typeparamref name="TKey" />. If it doesn't, an exception will be thrown.
10221020
</remarks>
10231021
<exception cref="T:System.InvalidOperationException">This instance's comparer is not compatible with <typeparamref name="TAlternateKey" />.</exception>
10241022
</Docs>

‎xml/System.Collections.Frozen/FrozenDictionary`2+AlternateLookup`1.xml‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,10 @@
4545
<typeparam name="TValue">The type of the values in the dictionary.</typeparam>
4646
<typeparam name="TAlternateKey">The alternate type of a key for performing lookups.</typeparam>
4747
<summary>
48-
<para>Provides a type that may be used to perform operations on a <see cref="T:System.Collections.Frozen.FrozenDictionary`2" /></para>
49-
<para>using a <typeparamref name="TAlternateKey" /> as a key instead of a <typeparamref name="TKey" />.</para>
48+
Provides a type that may be used to perform operations on a
49+
<see cref="T:System.Collections.Frozen.FrozenDictionary`2" />
50+
using a <typeparamref name="TAlternateKey" /> as a key
51+
instead of a <typeparamref name="TKey" />.
5052
</summary>
5153
<remarks>To be added.</remarks>
5254
</Docs>
@@ -125,8 +127,7 @@
125127
<param name="key">The alternate key of the value to get or set.</param>
126128
<summary>Gets or sets the value associated with the specified alternate key.</summary>
127129
<value>
128-
<para>The value associated with the specified alternate key. If the specified alternate key is not found, a get operation throws</para>
129-
<para>a <see cref="T:System.Collections.Generic.KeyNotFoundException" />, and a set operation creates a new element with the specified key.</para>
130+
The value associated with the specified alternate key. If the specified alternate key is not found, a get operation throws a <see cref="T:System.Collections.Generic.KeyNotFoundException" />, and a set operation creates a new element with the specified key.
130131
</value>
131132
<remarks>To be added.</remarks>
132133
<exception cref="T:System.ArgumentNullException">
@@ -164,8 +165,8 @@
164165
<Docs>
165166
<param name="key">The alternate key of the value to get.</param>
166167
<param name="value">
167-
<para>When this method returns, contains the value associated with the specified key, if the key is found;</para>
168-
<para>otherwise, the default value for the type of the value parameter.</para>
168+
When this method returns, contains the value associated with the specified key, if the key is found;
169+
otherwise, the default value for the type of the value parameter.
169170
</param>
170171
<summary>Gets the value associated with the specified alternate key.</summary>
171172
<returns>

‎xml/System.Collections.Frozen/FrozenDictionary`2.xml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -291,14 +291,14 @@
291291
<Docs>
292292
<typeparam name="TAlternateKey">The alternate type of a key for performing lookups.</typeparam>
293293
<summary>
294-
<para>Gets an instance of a type that may be used to perform operations on a <see cref="T:System.Collections.Frozen.FrozenDictionary`2" /></para>
295-
<para>using a <typeparamref name="TAlternateKey" /> as a key instead of a <typeparamref name="TKey" />.</para>
294+
Gets an instance of a type that may be used to perform operations on a <see cref="T:System.Collections.Frozen.FrozenDictionary`2" /> using a <typeparamref name="TAlternateKey" /> as a key instead of a <typeparamref name="TKey" />.
296295
</summary>
297296
<returns>The created lookup instance.</returns>
298297
<remarks>
299-
<para>This instance must be using a comparer that implements <see cref="T:System.Collections.Generic.IAlternateEqualityComparer`2" /> with</para>
300-
<para>
301-
<typeparamref name="TAlternateKey" /> and <typeparamref name="TKey" />. If it doesn't, an exception will be thrown.</para>
298+
This instance must be using a comparer that implements
299+
<see cref="T:System.Collections.Generic.IAlternateEqualityComparer`2" />
300+
with <typeparamref name="TAlternateKey" /> and <typeparamref name="TKey" />.
301+
If it doesn't, an exception will be thrown.
302302
</remarks>
303303
<exception cref="T:System.InvalidOperationException">This instance's comparer is not compatible with <typeparamref name="TAlternateKey" />.</exception>
304304
</Docs>

‎xml/System.Collections.Frozen/FrozenSet`1+AlternateLookup`1.xml‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,7 @@
4848
<Docs>
4949
<typeparam name="T">The type of the values in this set.</typeparam>
5050
<typeparam name="TAlternate">The alternate type of a key for performing lookups.</typeparam>
51-
<summary>
52-
<para>Provides a type that may be used to perform operations on a <see cref="T:System.Collections.Frozen.FrozenSet`1" /></para>
53-
<para>using a <typeparamref name="TAlternate" /> as a key instead of a <typeparamref name="T" />.</para>
54-
</summary>
51+
<summary>Provides a type that may be used to perform operations on a <see cref="T:System.Collections.Frozen.FrozenSet`1" /> using a <typeparamref name="TAlternate" /> as a key instead of a <typeparamref name="T" />.</summary>
5552
<remarks>To be added.</remarks>
5653
</Docs>
5754
<Members>

‎xml/System.Collections.Frozen/FrozenSet`1.xml‎

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -280,16 +280,9 @@
280280
<Parameters />
281281
<Docs>
282282
<typeparam name="TAlternate">The alternate type of a item for performing lookups.</typeparam>
283-
<summary>
284-
<para>Gets an instance of a type that may be used to perform operations on a <see cref="T:System.Collections.Frozen.FrozenSet`1" /></para>
285-
<para>using a <typeparamref name="TAlternate" /> instead of a <typeparamref name="T" />.</para>
286-
</summary>
283+
<summary>Gets an instance of a type that may be used to perform operations on a <see cref="T:System.Collections.Frozen.FrozenSet`1" /> using a <typeparamref name="TAlternate" /> instead of a <typeparamref name="T" />.</summary>
287284
<returns>The created lookup instance.</returns>
288-
<remarks>
289-
<para>This instance must be using a comparer that implements <see cref="T:System.Collections.Generic.IAlternateEqualityComparer`2" /> with</para>
290-
<para>
291-
<typeparamref name="TAlternate" /> and <typeparamref name="T" />. If it doesn't, an exception will be thrown.</para>
292-
</remarks>
285+
<remarks>This instance must be using a comparer that implements <see cref="T:System.Collections.Generic.IAlternateEqualityComparer`2" /> with <typeparamref name="TAlternate" /> and <typeparamref name="T" />. If it doesn't, an exception will be thrown.</remarks>
293286
<exception cref="T:System.InvalidOperationException">This instance's comparer is not compatible with <typeparamref name="TAlternate" />.</exception>
294287
</Docs>
295288
</Member>

0 commit comments

Comments
 (0)