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 4 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
3 changes: 1 addition & 2 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>
<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" />.</para>
</summary>
<remarks>To be added.</remarks>
</Docs>
Expand Down
3 changes: 1 addition & 2 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,8 +1011,7 @@
<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>
<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" />.</para>
</summary>
<returns>The created lookup instance.</returns>
<remarks>
Expand Down
3 changes: 1 addition & 2 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>
<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" />.</para>
</summary>
<remarks>To be added.</remarks>
</Docs>
Expand Down
3 changes: 1 addition & 2 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,8 +291,7 @@
<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>
<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" />.</para>
</summary>
<returns>The created lookup instance.</returns>
<remarks>
Expand Down
3 changes: 1 addition & 2 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 @@ -49,8 +49,7 @@
<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>
<para>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" />.</para>
</summary>
<remarks>To be added.</remarks>
</Docs>
Expand Down
3 changes: 1 addition & 2 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 @@ -281,8 +281,7 @@
<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>
<para>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" />.</para>
</summary>
<returns>The created lookup instance.</returns>
<remarks>
Expand Down
36 changes: 12 additions & 24 deletions xml/System.Collections.Generic/OrderedDictionary`2.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,7 @@
<typeparam name="TValue">The type of the values in the dictionary.</typeparam>
<summary>Represents a collection of key/value pairs that are accessible by the key or index.</summary>
<remarks>
<para>Operations on the collection have algorithmic complexities that are similar to that of the <see cref="T:System.Collections.Generic.List`1" /></para>
<para>class, except with lookups by key similar in complexity to that of <see cref="T:System.Collections.Generic.Dictionary`2" />.</para>
<para>Operations on the collection have algorithmic complexities that are similar to that of the <see cref="T:System.Collections.Generic.List`1" /> class, except with lookups by key similar in complexity to that of <see cref="T:System.Collections.Generic.Dictionary`2" />.</para>
</remarks>
</Docs>
<Members>
Expand All @@ -99,8 +98,7 @@
<Parameters />
<Docs>
<summary>
<para>Initializes a new instance of the <see cref="T:System.Collections.Generic.OrderedDictionary`2" /> class that is empty,</para>
<para>has the default initial capacity, and uses the default equality comparer for the key type.</para>
<para>Initializes a new instance of the <see cref="T:System.Collections.Generic.OrderedDictionary`2" /> class that is empty, has the default initial capacity, and uses the default equality comparer for the key type.</para>
</summary>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -127,8 +125,7 @@
<para>The initial order of the elements in the new collection is the order the elements are enumerated from the supplied dictionary.</para>
</param>
<summary>
<para>Initializes a new instance of the <see cref="T:System.Collections.Generic.OrderedDictionary`2" /> class that contains elements copied from</para>
<para>the specified <see cref="T:System.Collections.Generic.IDictionary`2" /> and uses the default equality comparer for the key type.</para>
<para>Initializes a new instance of the <see cref="T:System.Collections.Generic.OrderedDictionary`2" /> class that contains elements copied from the specified <see cref="T:System.Collections.Generic.IDictionary`2" /> and uses the default equality comparer for the key type.</para>
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
Expand Down Expand Up @@ -197,12 +194,10 @@
</Parameters>
<Docs>
<param name="comparer">
<para>The <see cref="T:System.Collections.Generic.IEqualityComparer`1" /> implementation to use when comparing keys,</para>
<para>or <see langword="null" /> to use the default <see cref="T:System.Collections.Generic.EqualityComparer`1" /> for the type of the key.</para>
<para>The <see cref="T:System.Collections.Generic.IEqualityComparer`1" /> implementation to use when comparing keys, or <see langword="null" /> to use the default <see cref="T:System.Collections.Generic.EqualityComparer`1" /> for the type of the key.</para>
</param>
<summary>
<para>Initializes a new instance of the <see cref="T:System.Collections.Generic.OrderedDictionary`2" /> class that is empty,</para>
<para>has the default initial capacity, and uses the specified <see cref="T:System.Collections.Generic.IEqualityComparer`1" />.</para>
<para>Initializes a new instance of the <see cref="T:System.Collections.Generic.OrderedDictionary`2" /> class that is empty, has the default initial capacity, and uses the specified <see cref="T:System.Collections.Generic.IEqualityComparer`1" />.</para>
</summary>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -226,8 +221,7 @@
<Docs>
<param name="capacity">The initial number of elements that the <see cref="T:System.Collections.Generic.OrderedDictionary`2" /> can contain.</param>
<summary>
<para>Initializes a new instance of the <see cref="T:System.Collections.Generic.OrderedDictionary`2" /> class that is empty,</para>
<para>has the specified initial capacity, and uses the default equality comparer for the key type.</para>
<para>Initializes a new instance of the <see cref="T:System.Collections.Generic.OrderedDictionary`2" /> class that is empty, has the specified initial capacity, and uses the default equality comparer for the key type.</para>
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">capacity is less than 0.</exception>
Expand Down Expand Up @@ -263,12 +257,10 @@
<para>The initial order of the elements in the new collection is the order the elements are enumerated from the supplied dictionary.</para>
</param>
<param name="comparer">
<para>The <see cref="T:System.Collections.Generic.IEqualityComparer`1" /> implementation to use when comparing keys,</para>
<para>or <see langword="null" /> to use the default <see cref="T:System.Collections.Generic.EqualityComparer`1" /> for the type of the key.</para>
<para>The <see cref="T:System.Collections.Generic.IEqualityComparer`1" /> implementation to use when comparing keys, or <see langword="null" /> to use the default <see cref="T:System.Collections.Generic.EqualityComparer`1" /> for the type of the key.</para>
</param>
<summary>
<para>Initializes a new instance of the <see cref="T:System.Collections.Generic.OrderedDictionary`2" /> class that contains elements copied from</para>
<para>the specified <see cref="T:System.Collections.Generic.IDictionary`2" /> and uses the specified <see cref="T:System.Collections.Generic.IEqualityComparer`1" />.</para>
<para>Initializes a new instance of the <see cref="T:System.Collections.Generic.OrderedDictionary`2" /> class that contains elements copied from the specified <see cref="T:System.Collections.Generic.IDictionary`2" /> and uses the specified <see cref="T:System.Collections.Generic.IEqualityComparer`1" />.</para>
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
Expand Down Expand Up @@ -312,12 +304,10 @@
<para>The initial order of the elements in the new collection is the order the elements are enumerated from the supplied collection.</para>
</param>
<param name="comparer">
<para>The <see cref="T:System.Collections.Generic.IEqualityComparer`1" /> implementation to use when comparing keys,</para>
<para>or <see langword="null" /> to use the default <see cref="T:System.Collections.Generic.EqualityComparer`1" /> for the type of the key.</para>
<para>The <see cref="T:System.Collections.Generic.IEqualityComparer`1" /> implementation to use when comparing keys, or <see langword="null" /> to use the default <see cref="T:System.Collections.Generic.EqualityComparer`1" /> for the type of the key.</para>
</param>
<summary>
<para>Initializes a new instance of the <see cref="T:System.Collections.Generic.OrderedDictionary`2" /> class that contains elements copied</para>
<para>from the specified <see cref="T:System.Collections.Generic.IEnumerable`1" /> and uses the specified <see cref="T:System.Collections.Generic.IEqualityComparer`1" />.</para>
<para>Initializes a new instance of the <see cref="T:System.Collections.Generic.OrderedDictionary`2" /> class that contains elements copied from the specified <see cref="T:System.Collections.Generic.IEnumerable`1" /> and uses the specified <see cref="T:System.Collections.Generic.IEqualityComparer`1" />.</para>
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
Expand Down Expand Up @@ -351,12 +341,10 @@
<Docs>
<param name="capacity">The initial number of elements that the <see cref="T:System.Collections.Generic.OrderedDictionary`2" /> can contain.</param>
<param name="comparer">
<para>The <see cref="T:System.Collections.Generic.IEqualityComparer`1" /> implementation to use when comparing keys,</para>
<para>or <see langword="null" /> to use the default <see cref="T:System.Collections.Generic.EqualityComparer`1" /> for the type of the key.</para>
<para>The <see cref="T:System.Collections.Generic.IEqualityComparer`1" /> implementation to use when comparing keys, or <see langword="null" /> to use the default <see cref="T:System.Collections.Generic.EqualityComparer`1" /> for the type of the key.</para>
</param>
<summary>
<para>Initializes a new instance of the <see cref="T:System.Collections.Generic.OrderedDictionary`2" /> class that is empty,</para>
<para>has the specified initial capacity, and uses the specified <see cref="T:System.Collections.Generic.IEqualityComparer`1" />.</para>
<para>Initializes a new instance of the <see cref="T:System.Collections.Generic.OrderedDictionary`2" /> class that is empty, has the specified initial capacity, and uses the specified <see cref="T:System.Collections.Generic.IEqualityComparer`1" />.</para>
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">capacity is less than 0.</exception>
Expand Down
17 changes: 5 additions & 12 deletions xml/System.Reflection.Metadata/TypeName.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,9 +135,7 @@
<para>names. For example, given "List&lt;int&gt;", the <see cref="P:System.Reflection.Metadata.TypeName.FullName" /> property will return</para>
<para>"System.Collections.Generic.List`1[[System.Int32, mscorlib, ...]]".</para>
<para>For open generic types, the convention is to use a backtick ("`") followed by</para>
<para>the arity of the generic type. For example, given "Dictionary&lt;,&gt;", the <see cref="P:System.Reflection.Metadata.TypeName.FullName" /></para>
<para>property will return "System.Collections.Generic.Dictionary`2". Given "Dictionary&lt;,&gt;.Enumerator",</para>
<para>the <see cref="P:System.Reflection.Metadata.TypeName.FullName" /> property will return "System.Collections.Generic.Dictionary`2+Enumerator".</para>
<para>the arity of the generic type. For example, given "Dictionary&lt;,&gt;", the <see cref="P:System.Reflection.Metadata.TypeName.FullName" /> property will return "System.Collections.Generic.Dictionary`2". Given "Dictionary&lt;,&gt;.Enumerator", the <see cref="P:System.Reflection.Metadata.TypeName.FullName" /> property will return "System.Collections.Generic.Dictionary`2+Enumerator".
<para>See ECMA-335, Sec. I.10.7.2 (Type names and arity encoding) for more information.</para>
</remarks>
</Docs>
Expand Down Expand Up @@ -276,8 +274,7 @@
<para>This value is computed every time this method gets called, it's not cached.</para>
<para>There's not really a parallel concept to this in reflection. Think of it</para>
<para>as the total number of <see cref="T:System.Reflection.Metadata.TypeName" /> instances that would be created if</para>
<para>you were to totally deconstruct this instance and visit each intermediate <see cref="T:System.Reflection.Metadata.TypeName" /></para>
<para>that occurs as part of deconstruction.</para>
<para>you were to totally deconstruct this instance and visit each intermediate <see cref="T:System.Reflection.Metadata.TypeName" /> that occurs as part of deconstruction.</para>
<para>"int" and "Person" each have complexities of 1 because they're standalone types.</para>
<para>"int[]" has a node count of 2 because to fully inspect it involves inspecting the</para>
<para>array type itself, <em>plus</em> unwrapping the underlying type ("int") and inspecting that.</para>
Expand Down Expand Up @@ -458,17 +455,13 @@
</ReturnValue>
<Docs>
<summary>
<para>Gets a value that indicates whether this is a "plain" type; that is, not an array, not a pointer, not a reference, and</para>
<para>not a constructed generic type. Examples of elemental types are "System.Int32",</para>
<para>"System.Uri", and "YourNamespace.YourClass".</para>
<para>Gets a value that indicates whether this is a "plain" type; that is, not an array, not a pointer, not a reference, and not a constructed generic type. Examples of elemental types are "System.Int32", "System.Uri", and "YourNamespace.YourClass".</para>
</summary>
<value>To be added.</value>
<remarks>
<para>This property returning <see langword="true" /> doesn't mean that the type is a primitive like string</para>
<para>or int; it just means that there's no underlying type.</para>
<para>This property returning <see langword="true" /> doesn't mean that the type is a primitive like string or int; it just means that there's no underlying type.</para>
<para>This property will return <see langword="true" /> for generic type definitions (for example, "Dictionary&lt;,&gt;").</para>
<para>This is because determining whether a type truly is a generic type requires loading the type</para>
<para>and performing a runtime check.</para>
<para>This is because determining whether a type truly is a generic type requires loading the type and performing a runtime check.</para>
</remarks>
</Docs>
</Member>
Expand Down
3 changes: 1 addition & 2 deletions xml/System.Text.Json.Serialization.Metadata/JsonParameterInfo.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,8 +176,7 @@
<para>Contracts originating from <see cref="T:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver" /> or <see cref="T:System.Text.Json.Serialization.JsonSerializerContext" />,</para>
<para>derive the value of this parameter from nullable reference type annotations, including annotations</para>
<para>from attributes such as <see cref="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute" /> or <see cref="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute" />.</para>
<para>This property has no effect on deserialization unless the <see cref="P:System.Text.Json.JsonSerializerOptions.RespectNullableAnnotations" /></para>
<para>property has been enabled, in which case the serializer will reject any <see langword="null" /> deserialization results.</para>
<para>This property has no effect on deserialization unless the <see cref="P:System.Text.Json.JsonSerializerOptions.RespectNullableAnnotations" /> property has been enabled, in which case the serializer will reject any <see langword="null" /> deserialization results.</para>
<para>This setting is in sync with the associated <see cref="P:System.Text.Json.Serialization.Metadata.JsonPropertyInfo.IsSetNullable" /> property.</para>
</remarks>
</Docs>
Expand Down
Loading