Skip to content

Fix formatting issue in OrderedDictionary<TKey,TValue> documentation #11458

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.

Sign up for GitHub

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 11 commits into from
Jun 19, 2025
Merged

Fix formatting issue in OrderedDictionary<TKey,TValue> documentation #11458

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
53042ab
Initial plan for issue
Copilot Jun 16, 2025
5acb482
Fix formatting issue in OrderedDictionary<TKey,TValue> documentation
Copilot Jun 16, 2025
4b82e19
Fix all errant para tag formatting issues across documentation files
Copilot Jun 17, 2025
ed95b65
Fix additional errant para tag patterns per review feedback
Copilot Jun 17, 2025
8ae8774
Apply comprehensive para tag cleanup to TypeName.xml per review feedback
Copilot Jun 17, 2025
0c7ee50
Fix indentation in TypeName.xml after para tag cleanup
Copilot Jun 17, 2025
07c9e95
Remove superfluous para tags and fix XML formatting per review feedback
Copilot Jun 17, 2025
3de5667
Remove unnecessary para tags and fix XML formatting per detailed revi…
Copilot Jun 18, 2025
678a55a
Fix malformed XML with orphaned para tags and apply proper formatting…
Copilot Jun 18, 2025
e21a9b8
Fix XML formatting: use 2-space indentation, add line breaks for long…
Copilot Jun 18, 2025
f2f873a
Formatting tweaks
jeffhandley Jun 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 9 additions & 18 deletions xml/System.Collections.Concurrent/ConcurrentDictionary`2+AlternateLookup`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,7 @@
<typeparam name="TValue">The type of the values in the dictionary.</typeparam>
<typeparam name="TAlternateKey">The alternate type of a key for performing lookups.</typeparam>
<summary>
<para>Provides a type that may be used to perform operations on a <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /></para>
<para>using a <typeparamref name="TAlternateKey" /> as a key instead of a <typeparamref name="TKey" />.</para>
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" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -129,8 +128,7 @@
<param name="key">The alternate key of the value to get or set.</param>
<summary>Gets or sets the value associated with the specified alternate key.</summary>
<value>
<para>The value associated with the specified alternate key. If the specified alternate key is not found, a get operation throws</para>
<para>a <see cref="T:System.Collections.Generic.KeyNotFoundException" />, and a set operation creates a new element with the specified key.</para>
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.
</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
Expand Down Expand Up @@ -198,10 +196,7 @@
</Parameters>
<Docs>
<param name="key">The alternate key of the value to get.</param>
<param name="value">
<para>When this method returns, contains the value associated with the specified key, if the key is found;</para>
<para>otherwise, the default value for the type of the value parameter.</para>
</param>
<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>
<summary>Gets the value associated with the specified alternate key.</summary>
<returns>
<see langword="true" /> if an entry was found; otherwise, <see langword="false" />.</returns>
Expand Down Expand Up @@ -248,12 +243,11 @@
<Docs>
<param name="key">The alternate key of the value to get.</param>
<param name="actualKey">
<para>When this method returns, contains the actual key associated with the alternate key, if the key is found;</para>
<para>otherwise, the default value for the type of the key parameter.</para>
When this method returns, contains the actual key associated with the alternate key, if the key is found;
otherwise, the default value for the type of the key parameter.
</param>
<param name="value">
<para>When this method returns, contains the value associated with the specified key, if the key is found;</para>
<para>otherwise, the default value for the type of the value parameter.</para>
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>
<summary>Gets the value associated with the specified alternate key.</summary>
<returns>
Expand Down Expand Up @@ -293,10 +287,7 @@
<Docs>
<param name="key">The alternate key of the element to remove.</param>
<param name="value">The removed element.</param>
<summary>
<para>Removes the value with the specified alternate key from the <see cref="T:System.Collections.Generic.Dictionary`2" />,</para>
<para>and copies the element to the value parameter.</para>
</summary>
<summary>Removes the value with the specified alternate key from the <see cref="T:System.Collections.Generic.Dictionary`2" />, and copies the element to the value parameter.</summary>
<returns>
<see langword="true" /> if the element is successfully found and removed; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
Expand Down Expand Up @@ -344,8 +335,8 @@
<param name="actualKey">The removed key.</param>
<param name="value">The removed element.</param>
<summary>
<para>Removes the value with the specified alternate key from the <see cref="T:System.Collections.Generic.Dictionary`2" />,</para>
<para>and copies the associated key and element to the value parameter.</para>
Removes the value with the specified alternate key from the <see cref="T:System.Collections.Generic.Dictionary`2" />,
and copies the associated key and element to the value parameter.
</summary>
<returns>
<see langword="true" /> if the element is successfully found and removed; otherwise, <see langword="false" />.</returns>
Expand Down
8 changes: 3 additions & 5 deletions xml/System.Collections.Concurrent/ConcurrentDictionary`2.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1011,14 +1011,12 @@
<Docs>
<typeparam name="TAlternateKey">The alternate type of a key for performing lookups.</typeparam>
<summary>
<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>
<para>using a <typeparamref name="TAlternateKey" /> as a key instead of a <typeparamref name="TKey" />.</para>
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" />.
</summary>
<returns>The created lookup instance.</returns>
<remarks>
<para>This instance must be using a comparer that implements <see cref="T:System.Collections.Generic.IAlternateEqualityComparer`2" /> with</para>
<para>
<typeparamref name="TAlternateKey" /> and <typeparamref name="TKey" />. If it doesn't, an exception will be thrown.</para>
This instance must be using a comparer that implements <see cref="T:System.Collections.Generic.IAlternateEqualityComparer`2" /> with
<typeparamref name="TAlternateKey" /> and <typeparamref name="TKey" />. If it doesn't, an exception will be thrown.
</remarks>
<exception cref="T:System.InvalidOperationException">This instance's comparer is not compatible with <typeparamref name="TAlternateKey" />.</exception>
</Docs>
Expand Down
10 changes: 4 additions & 6 deletions xml/System.Collections.Frozen/FrozenDictionary`2+AlternateLookup`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,7 @@
<typeparam name="TValue">The type of the values in the dictionary.</typeparam>
<typeparam name="TAlternateKey">The alternate type of a key for performing lookups.</typeparam>
<summary>
<para>Provides a type that may be used to perform operations on a <see cref="T:System.Collections.Frozen.FrozenDictionary`2" /></para>
<para>using a <typeparamref name="TAlternateKey" /> as a key instead of a <typeparamref name="TKey" />.</para>
Provides 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" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -125,8 +124,7 @@
<param name="key">The alternate key of the value to get or set.</param>
<summary>Gets or sets the value associated with the specified alternate key.</summary>
<value>
<para>The value associated with the specified alternate key. If the specified alternate key is not found, a get operation throws</para>
<para>a <see cref="T:System.Collections.Generic.KeyNotFoundException" />, and a set operation creates a new element with the specified key.</para>
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.
</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
Expand Down Expand Up @@ -164,8 +162,8 @@
<Docs>
<param name="key">The alternate key of the value to get.</param>
<param name="value">
<para>When this method returns, contains the value associated with the specified key, if the key is found;</para>
<para>otherwise, the default value for the type of the value parameter.</para>
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>
<summary>Gets the value associated with the specified alternate key.</summary>
<returns>
Expand Down
9 changes: 2 additions & 7 deletions xml/System.Collections.Frozen/FrozenDictionary`2.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,15 +291,10 @@
<Docs>
<typeparam name="TAlternateKey">The alternate type of a key for performing lookups.</typeparam>
<summary>
<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>
<para>using a <typeparamref name="TAlternateKey" /> as a key instead of a <typeparamref name="TKey" />.</para>
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" />.
</summary>
<returns>The created lookup instance.</returns>
<remarks>
<para>This instance must be using a comparer that implements <see cref="T:System.Collections.Generic.IAlternateEqualityComparer`2" /> with</para>
<para>
<typeparamref name="TAlternateKey" /> and <typeparamref name="TKey" />. If it doesn't, an exception will be thrown.</para>
</remarks>
<remarks>This instance must be using a comparer that implements <see cref="T:System.Collections.Generic.IAlternateEqualityComparer`2" /> with <typeparamref name="TAlternateKey" /> and <typeparamref name="TKey" />. If it doesn't, an exception will be thrown.</remarks>
<exception cref="T:System.InvalidOperationException">This instance's comparer is not compatible with <typeparamref name="TAlternateKey" />.</exception>
</Docs>
</Member>
Expand Down
5 changes: 1 addition & 4 deletions xml/System.Collections.Frozen/FrozenSet`1+AlternateLookup`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,7 @@
<Docs>
<typeparam name="T">The type of the values in this set.</typeparam>
<typeparam name="TAlternate">The alternate type of a key for performing lookups.</typeparam>
<summary>
<para>Provides a type that may be used to perform operations on a <see cref="T:System.Collections.Frozen.FrozenSet`1" /></para>
<para>using a <typeparamref name="TAlternate" /> as a key instead of a <typeparamref name="T" />.</para>
</summary>
<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>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down
11 changes: 2 additions & 9 deletions xml/System.Collections.Frozen/FrozenSet`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,16 +280,9 @@
<Parameters />
<Docs>
<typeparam name="TAlternate">The alternate type of a item for performing lookups.</typeparam>
<summary>
<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>
<para>using a <typeparamref name="TAlternate" /> instead of a <typeparamref name="T" />.</para>
</summary>
<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>
<returns>The created lookup instance.</returns>
<remarks>
<para>This instance must be using a comparer that implements <see cref="T:System.Collections.Generic.IAlternateEqualityComparer`2" /> with</para>
<para>
<typeparamref name="TAlternate" /> and <typeparamref name="T" />. If it doesn't, an exception will be thrown.</para>
</remarks>
<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>
<exception cref="T:System.InvalidOperationException">This instance's comparer is not compatible with <typeparamref name="TAlternate" />.</exception>
</Docs>
</Member>
Expand Down
Loading