From a03a4135977b851c39207d2f2106006d4eb05e25 Mon Sep 17 00:00:00 2001 From: carlossanlop Date: Wed, 26 Feb 2020 20:15:56 -0800 Subject: [PATCH 1/6] Automatic port of System.Collections.Immutable --- .../ImmutableDictionary`2+Builder.xml | 17 ++++---- .../ImmutableDictionary`2.xml | 31 +++++++------- .../ImmutableSortedDictionary`2+Builder.xml | 4 +- .../ImmutableSortedDictionary`2.xml | 41 ++++++++++--------- 4 files changed, 48 insertions(+), 45 deletions(-) diff --git a/xml/System.Collections.Immutable/ImmutableDictionary`2+Builder.xml b/xml/System.Collections.Immutable/ImmutableDictionary`2+Builder.xml index 6b559f579c5..83b5606211c 100644 --- a/xml/System.Collections.Immutable/ImmutableDictionary`2+Builder.xml +++ b/xml/System.Collections.Immutable/ImmutableDictionary`2+Builder.xml @@ -700,8 +700,9 @@ System.Boolean - To be added. - To be added. + Gets a value indicating whether the is read-only. + + if the is read-only; otherwise, . To be added. @@ -730,8 +731,8 @@ System.Collections.Generic.ICollection<TKey> - To be added. - To be added. + Gets an containing the keys of the . + An containing the keys of the object that implements . To be added. @@ -760,8 +761,8 @@ System.Collections.Generic.ICollection<TValue> - To be added. - To be added. + Gets an containing the values in the . + An containing the values in the object that implements . To be added. @@ -790,8 +791,8 @@ - To be added. - To be added. + Returns an enumerator that iterates through the collection. + A that can be used to iterate through the collection. To be added. diff --git a/xml/System.Collections.Immutable/ImmutableDictionary`2.xml b/xml/System.Collections.Immutable/ImmutableDictionary`2.xml index fe7f6ffb75f..edbabef5649 100644 --- a/xml/System.Collections.Immutable/ImmutableDictionary`2.xml +++ b/xml/System.Collections.Immutable/ImmutableDictionary`2.xml @@ -816,9 +816,9 @@ - To be added. - To be added. - To be added. + The object to use as the key of the element to add. + The object to use as the value of the element to add. + Adds an element with the provided key and value to the . To be added. @@ -851,7 +851,7 @@ To be added. - To be added. + Gets or sets the with the specified key. To be added. To be added. @@ -881,7 +881,7 @@ System.Collections.Generic.ICollection<TKey> - To be added. + Gets the keys. To be added. To be added. @@ -913,9 +913,10 @@ - To be added. - To be added. - To be added. + The key of the element to remove. + Removes the element with the specified key from the . + + if the element is successfully removed; otherwise, . This method also returns if was not found in the original . To be added. @@ -944,7 +945,7 @@ System.Collections.Generic.ICollection<TValue> - To be added. + Gets the values. To be added. To be added. @@ -974,8 +975,8 @@ - To be added. - To be added. + Returns an enumerator that iterates through the collection. + A that can be used to iterate through the collection. To be added. @@ -1571,7 +1572,7 @@ - To be added. + Gets the empty instance. To be added. To be added. @@ -1704,9 +1705,9 @@ - To be added. - To be added. - To be added. + The key=value pairs to set on the map. Any keys that conflict with existing keys will overwrite the previous values. + Applies a given set of key=value pairs to an immutable dictionary, replacing any conflicting keys in the resulting dictionary. + An immutable dictionary. To be added. diff --git a/xml/System.Collections.Immutable/ImmutableSortedDictionary`2+Builder.xml b/xml/System.Collections.Immutable/ImmutableSortedDictionary`2+Builder.xml index 4c750f9892d..b05b1c4ac22 100644 --- a/xml/System.Collections.Immutable/ImmutableSortedDictionary`2+Builder.xml +++ b/xml/System.Collections.Immutable/ImmutableSortedDictionary`2+Builder.xml @@ -676,8 +676,8 @@ System.Boolean - To be added. - To be added. + Gets a value indicating whether this instance is read-only. + Always . To be added. diff --git a/xml/System.Collections.Immutable/ImmutableSortedDictionary`2.xml b/xml/System.Collections.Immutable/ImmutableSortedDictionary`2.xml index 26725ba47e2..a0454b5bd3c 100644 --- a/xml/System.Collections.Immutable/ImmutableSortedDictionary`2.xml +++ b/xml/System.Collections.Immutable/ImmutableSortedDictionary`2.xml @@ -798,9 +798,9 @@ - To be added. - To be added. - To be added. + The object to use as the key of the element to add. + The object to use as the value of the element to add. + Adds an element with the provided key and value to the . To be added. @@ -833,7 +833,7 @@ To be added. - To be added. + Gets or sets the with the specified key. To be added. To be added. @@ -863,7 +863,7 @@ System.Collections.Generic.ICollection<TKey> - To be added. + Gets the keys. To be added. To be added. @@ -895,9 +895,10 @@ - To be added. - To be added. - To be added. + The key of the element to remove. + Removes the element with the specified key from the . + + if the element is successfully removed; otherwise, . This method also returns if was not found in the original . To be added. @@ -926,7 +927,7 @@ System.Collections.Generic.ICollection<TValue> - To be added. + Gets the values. To be added. To be added. @@ -956,8 +957,8 @@ - To be added. - To be added. + Returns an enumerator that iterates through the collection. + A that can be used to iterate through the collection. To be added. @@ -1490,7 +1491,7 @@ To be added. To be added. - To be added. + See the interface. To be added. To be added. @@ -1523,7 +1524,7 @@ To be added. - To be added. + See the interface. To be added. To be added. @@ -1553,7 +1554,7 @@ - To be added. + See the interface. To be added. To be added. @@ -1586,7 +1587,7 @@ To be added. - To be added. + See the interface. To be added. To be added. @@ -1619,7 +1620,7 @@ To be added. - To be added. + See the interface. To be added. To be added. @@ -1654,7 +1655,7 @@ To be added. To be added. - To be added. + See the interface. To be added. To be added. @@ -1686,9 +1687,9 @@ - To be added. - To be added. - To be added. + The key=value pairs to set on the map. Any keys that conflict with existing keys will overwrite the previous values. + Applies a given set of key=value pairs to an immutable dictionary, replacing any conflicting keys in the resulting dictionary. + An immutable dictionary. To be added. From ad24cd13821d303833068fe74f216dd0e8008ae0 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Fri, 28 Feb 2020 11:19:28 -0800 Subject: [PATCH 2/6] suggestions by mairaw Co-Authored-By: Maira Wenzel --- .../ImmutableDictionary`2+Builder.xml | 4 ++-- .../ImmutableDictionary`2.xml | 10 ++++---- .../ImmutableSortedDictionary`2+Builder.xml | 2 +- .../ImmutableSortedDictionary`2.xml | 24 +++++++++---------- 4 files changed, 20 insertions(+), 20 deletions(-) diff --git a/xml/System.Collections.Immutable/ImmutableDictionary`2+Builder.xml b/xml/System.Collections.Immutable/ImmutableDictionary`2+Builder.xml index 83b5606211c..ef0e0ddb503 100644 --- a/xml/System.Collections.Immutable/ImmutableDictionary`2+Builder.xml +++ b/xml/System.Collections.Immutable/ImmutableDictionary`2+Builder.xml @@ -700,9 +700,9 @@ System.Boolean - Gets a value indicating whether the is read-only. + Gets a value that indicates whether the collection is read-only. - if the is read-only; otherwise, . + if the collection is read-only; otherwise, . To be added. diff --git a/xml/System.Collections.Immutable/ImmutableDictionary`2.xml b/xml/System.Collections.Immutable/ImmutableDictionary`2.xml index edbabef5649..f549d188483 100644 --- a/xml/System.Collections.Immutable/ImmutableDictionary`2.xml +++ b/xml/System.Collections.Immutable/ImmutableDictionary`2.xml @@ -850,9 +850,9 @@ - To be added. + The type of the key. Gets or sets the with the specified key. - To be added. + An object of type associated with the . To be added. @@ -882,7 +882,7 @@ Gets the keys. - To be added. + An containing the keys. To be added. @@ -946,7 +946,7 @@ Gets the values. - To be added. + An containing the values. To be added. @@ -1705,7 +1705,7 @@ - The key=value pairs to set on the map. Any keys that conflict with existing keys will overwrite the previous values. + The key=value pairs to set on the map. Any keys that conflict with existing keys will overwrite the previous values. Applies a given set of key=value pairs to an immutable dictionary, replacing any conflicting keys in the resulting dictionary. An immutable dictionary. To be added. diff --git a/xml/System.Collections.Immutable/ImmutableSortedDictionary`2+Builder.xml b/xml/System.Collections.Immutable/ImmutableSortedDictionary`2+Builder.xml index b05b1c4ac22..6af268bfd9b 100644 --- a/xml/System.Collections.Immutable/ImmutableSortedDictionary`2+Builder.xml +++ b/xml/System.Collections.Immutable/ImmutableSortedDictionary`2+Builder.xml @@ -676,7 +676,7 @@ System.Boolean - Gets a value indicating whether this instance is read-only. + Gets a value that indicates whether this instance is read-only. Always . To be added. diff --git a/xml/System.Collections.Immutable/ImmutableSortedDictionary`2.xml b/xml/System.Collections.Immutable/ImmutableSortedDictionary`2.xml index a0454b5bd3c..b93c2e4904f 100644 --- a/xml/System.Collections.Immutable/ImmutableSortedDictionary`2.xml +++ b/xml/System.Collections.Immutable/ImmutableSortedDictionary`2.xml @@ -834,7 +834,7 @@ To be added. Gets or sets the with the specified key. - To be added. + An object of type associated with the . To be added. @@ -864,7 +864,7 @@ Gets the keys. - To be added. + An containing the keys. To be added. @@ -928,7 +928,7 @@ Gets the values. - To be added. + An containing the values. To be added. @@ -1492,7 +1492,7 @@ To be added. To be added. See the interface. - To be added. + The instance. To be added. @@ -1525,7 +1525,7 @@ To be added. See the interface. - To be added. + The instance. To be added. @@ -1555,7 +1555,7 @@ See the interface. - To be added. + The instance. To be added. @@ -1588,7 +1588,7 @@ To be added. See the interface. - To be added. + The instance. To be added. @@ -1621,7 +1621,7 @@ To be added. See the interface. - To be added. + The instance. To be added. @@ -1656,7 +1656,7 @@ To be added. To be added. See the interface. - To be added. + The instance. To be added. @@ -1687,9 +1687,9 @@ - The key=value pairs to set on the map. Any keys that conflict with existing keys will overwrite the previous values. - Applies a given set of key=value pairs to an immutable dictionary, replacing any conflicting keys in the resulting dictionary. - An immutable dictionary. + A set of key-value pairs to set on the map. + Applies a given set of key-value pairs to an immutable dictionary, replacing any conflicting keys in the resulting dictionary. + The instance. To be added. From 5257b1b7afc387bbae20c2610adcd9ccbf217596 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Mon, 2 Mar 2020 10:35:32 -0800 Subject: [PATCH 3/6] Apply suggestions from code review Co-Authored-By: Eirik Tsarpalis --- .../ImmutableDictionary`2+Builder.xml | 10 +++++----- .../ImmutableDictionary`2.xml | 18 +++++++++--------- .../ImmutableSortedDictionary`2.xml | 14 +++++++------- 3 files changed, 21 insertions(+), 21 deletions(-) diff --git a/xml/System.Collections.Immutable/ImmutableDictionary`2+Builder.xml b/xml/System.Collections.Immutable/ImmutableDictionary`2+Builder.xml index ef0e0ddb503..6f6152a4ff9 100644 --- a/xml/System.Collections.Immutable/ImmutableDictionary`2+Builder.xml +++ b/xml/System.Collections.Immutable/ImmutableDictionary`2+Builder.xml @@ -731,8 +731,8 @@ System.Collections.Generic.ICollection<TKey> - Gets an containing the keys of the . - An containing the keys of the object that implements . + Gets a collection containing the keys of the generic dictionary. + A collection containing the keys of the object that implements the generic dictionary. To be added. @@ -761,8 +761,8 @@ System.Collections.Generic.ICollection<TValue> - Gets an containing the values in the . - An containing the values in the object that implements . + Gets a collection containing the values in the generic dictionary. + A collection containing the values in the object that implements the generic dictionary. To be added. @@ -792,7 +792,7 @@ Returns an enumerator that iterates through the collection. - A that can be used to iterate through the collection. + An enumerator that can be used to iterate through the collection. To be added. diff --git a/xml/System.Collections.Immutable/ImmutableDictionary`2.xml b/xml/System.Collections.Immutable/ImmutableDictionary`2.xml index f549d188483..de6c908fb72 100644 --- a/xml/System.Collections.Immutable/ImmutableDictionary`2.xml +++ b/xml/System.Collections.Immutable/ImmutableDictionary`2.xml @@ -818,7 +818,7 @@ The object to use as the key of the element to add. The object to use as the value of the element to add. - Adds an element with the provided key and value to the . + Adds an element with the provided key and value to the immutable dictionary. To be added. @@ -852,7 +852,7 @@ The type of the key. Gets or sets the with the specified key. - An object of type associated with the . + An object of type associated with the . To be added. @@ -882,7 +882,7 @@ Gets the keys. - An containing the keys. + A collection containing the keys. To be added. @@ -914,9 +914,9 @@ The key of the element to remove. - Removes the element with the specified key from the . + Removes the element with the specified key from the generic dictionary. - if the element is successfully removed; otherwise, . This method also returns if was not found in the original . + if the element is successfully removed; otherwise, . This method also returns if was not found in the original generic dictionary. To be added. @@ -946,7 +946,7 @@ Gets the values. - An containing the values. + A collection containing the values. To be added. @@ -976,7 +976,7 @@ Returns an enumerator that iterates through the collection. - A that can be used to iterate through the collection. + An enumerator that can be used to iterate through the collection. To be added. @@ -1706,8 +1706,8 @@ The key=value pairs to set on the map. Any keys that conflict with existing keys will overwrite the previous values. - Applies a given set of key=value pairs to an immutable dictionary, replacing any conflicting keys in the resulting dictionary. - An immutable dictionary. + Applies a given set of key-value pairs to an immutable dictionary, replacing any conflicting keys in the resulting dictionary. + A copy of the immutable dictionary with updated key-value pairs. To be added. diff --git a/xml/System.Collections.Immutable/ImmutableSortedDictionary`2.xml b/xml/System.Collections.Immutable/ImmutableSortedDictionary`2.xml index b93c2e4904f..0c4335de9e9 100644 --- a/xml/System.Collections.Immutable/ImmutableSortedDictionary`2.xml +++ b/xml/System.Collections.Immutable/ImmutableSortedDictionary`2.xml @@ -800,7 +800,7 @@ The object to use as the key of the element to add. The object to use as the value of the element to add. - Adds an element with the provided key and value to the . + Adds an element with the provided key and value to the generic dictionary. To be added. @@ -834,7 +834,7 @@ To be added. Gets or sets the with the specified key. - An object of type associated with the . + An object of type associated with the . To be added. @@ -864,7 +864,7 @@ Gets the keys. - An containing the keys. + A collection containing the keys. To be added. @@ -896,9 +896,9 @@ The key of the element to remove. - Removes the element with the specified key from the . + Removes the element with the specified key from the generic dictionary. - if the element is successfully removed; otherwise, . This method also returns if was not found in the original . + if the element is successfully removed; otherwise, . This method also returns if was not found in the original generic dictionary. To be added. @@ -928,7 +928,7 @@ Gets the values. - An containing the values. + A collection containing the values. To be added. @@ -958,7 +958,7 @@ Returns an enumerator that iterates through the collection. - A that can be used to iterate through the collection. + An enumerator that can be used to iterate through the collection. To be added. From 0e036e3ed4603eb049b0e39138256348d5bbd320 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Mon, 2 Mar 2020 10:36:07 -0800 Subject: [PATCH 4/6] overwrite -> replace --- xml/System.Collections.Immutable/ImmutableDictionary`2.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Collections.Immutable/ImmutableDictionary`2.xml b/xml/System.Collections.Immutable/ImmutableDictionary`2.xml index de6c908fb72..1258f203e1f 100644 --- a/xml/System.Collections.Immutable/ImmutableDictionary`2.xml +++ b/xml/System.Collections.Immutable/ImmutableDictionary`2.xml @@ -1705,7 +1705,7 @@ - The key=value pairs to set on the map. Any keys that conflict with existing keys will overwrite the previous values. + The key-value pairs to set on the map. Any keys that conflict with existing keys will replace the previous values. Applies a given set of key-value pairs to an immutable dictionary, replacing any conflicting keys in the resulting dictionary. A copy of the immutable dictionary with updated key-value pairs. To be added. From 5469124d1d3a86375c87dd7699eeccc255d9133b Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Mon, 2 Mar 2020 15:49:56 -0800 Subject: [PATCH 5/6] Apply suggestions from code review Co-Authored-By: Eirik Tsarpalis --- xml/System.Collections.Immutable/ImmutableDictionary`2.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/System.Collections.Immutable/ImmutableDictionary`2.xml b/xml/System.Collections.Immutable/ImmutableDictionary`2.xml index 1258f203e1f..95e72ec2529 100644 --- a/xml/System.Collections.Immutable/ImmutableDictionary`2.xml +++ b/xml/System.Collections.Immutable/ImmutableDictionary`2.xml @@ -1572,8 +1572,8 @@ - Gets the empty instance. - To be added. + Retrieves an empty dictionary that has the same ordering and key-value comparison rules as this dictionary instance. + The immutable dictionary instance. To be added. From 951c8b8e1c3a5484ff3cb421295612215fd6305d Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Wed, 4 Mar 2020 17:16:41 -0800 Subject: [PATCH 6/6] Reverting bad documentation to "To be added" --- .../ImmutableSortedDictionary`2.xml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/xml/System.Collections.Immutable/ImmutableSortedDictionary`2.xml b/xml/System.Collections.Immutable/ImmutableSortedDictionary`2.xml index 0c4335de9e9..e84dc85b44d 100644 --- a/xml/System.Collections.Immutable/ImmutableSortedDictionary`2.xml +++ b/xml/System.Collections.Immutable/ImmutableSortedDictionary`2.xml @@ -1491,7 +1491,7 @@ To be added. To be added. - See the interface. + To be added. The instance. To be added. @@ -1524,7 +1524,7 @@ To be added. - See the interface. + To be added. The instance. To be added. @@ -1554,7 +1554,7 @@ - See the interface. + To be added. The instance. To be added. @@ -1587,7 +1587,7 @@ To be added. - See the interface. + To be added. The instance. To be added. @@ -1620,7 +1620,7 @@ To be added. - See the interface. + To be added. The instance. To be added. @@ -1655,7 +1655,7 @@ To be added. To be added. - See the interface. + To be added. The instance. To be added.