From aedd552e88f7630e305f992315ac9c81790edf3e Mon Sep 17 00:00:00 2001 From: carlossanlop Date: Mon, 15 Jul 2019 17:32:25 -0700 Subject: [PATCH 01/19] Automatic port of triple slash from System --- xml/System/AggregateException.xml | 4 +- xml/System/Double.xml | 24 +++---- xml/System/Environment.xml | 6 +- xml/System/FormattableString.xml | 22 ++++-- xml/System/Index.xml | 109 ++++++++++++++++++++---------- xml/System/Progress`1.xml | 1 + xml/System/Range.xml | 88 ++++++++++++++++-------- xml/System/ReadOnlySpan`1.xml | 12 +++- xml/System/SequencePosition.xml | 41 +++++++---- xml/System/Single.xml | 24 +++---- xml/System/Span`1.xml | 14 +++- xml/System/String.xml | 21 ++++-- xml/System/ValueTuple.xml | 12 +++- xml/System/ValueTuple`2.xml | 15 +++- 14 files changed, 271 insertions(+), 122 deletions(-) diff --git a/xml/System/AggregateException.xml b/xml/System/AggregateException.xml index ab49f6f501d..793c55c3c94 100644 --- a/xml/System/AggregateException.xml +++ b/xml/System/AggregateException.xml @@ -728,8 +728,8 @@ System.String - To be added. - To be added. + Gets a message that describes the exception. + A string representing the message that describes the exception. To be added. diff --git a/xml/System/Double.xml b/xml/System/Double.xml index a00dc3e4d33..265c348be38 100644 --- a/xml/System/Double.xml +++ b/xml/System/Double.xml @@ -850,9 +850,9 @@ - To be added. - To be added. - To be added. + A double-precision floating-point number. + Determines whether the specified value is finite (zero, subnormal, or normal). + if the value is finite (zero, subnormal or normal), otherwise. To be added. @@ -1021,9 +1021,9 @@ - To be added. - To be added. - To be added. + A double-precision floating-point number. + Determines whether the specified value is negative. + if the value is negative, otherwise. To be added. @@ -1122,9 +1122,9 @@ - To be added. - To be added. - To be added. + A double-precision floating-point number. + Determines whether the specified value is normal. + if the value is normal, otherwise. To be added. @@ -1217,9 +1217,9 @@ - To be added. - To be added. - To be added. + A double-precision floating-point number. + Determines whether the specified value is subnormal. + if the value is subnormal, otherwise. To be added. diff --git a/xml/System/Environment.xml b/xml/System/Environment.xml index 001bc836ad5..5c64dd68d49 100644 --- a/xml/System/Environment.xml +++ b/xml/System/Environment.xml @@ -2076,8 +2076,8 @@ The following example creates environment variables for the System.Int64 - To be added. - To be added. + Gets the number of milliseconds elapsed since the system started. + The elapsed milliseconds since the system started. To be added. @@ -2360,4 +2360,4 @@ The following example creates environment variables for the - + \ No newline at end of file diff --git a/xml/System/FormattableString.xml b/xml/System/FormattableString.xml index 6166d0c9953..173d779ce04 100644 --- a/xml/System/FormattableString.xml +++ b/xml/System/FormattableString.xml @@ -142,10 +142,24 @@ - To be added. - To be added. - To be added. - To be added. + The string to be formatted. + Format the given object in the current culture. + The formatted string in the current culture. + + + . diff --git a/xml/System/Index.xml b/xml/System/Index.xml index 2968eeb9308..9f9c62c9592 100644 --- a/xml/System/Index.xml +++ b/xml/System/Index.xml @@ -27,8 +27,19 @@ - To be added. - To be added. + Represent a type can be used to index a collection either from the start or the end. + + + @@ -52,10 +63,20 @@ - To be added. - To be added. - To be added. - To be added. + The index value. It has to be greater or equal than zero. + A boolean indicating if the index is from the start or from the end . + Construct an Index using a value and indicating if the index is from the start or from the end. + + + + + @@ -78,8 +99,8 @@ System.Index - To be added. - To be added. + Create an Index pointing at beyond last element. + The Index pointing at beyond last element. To be added. @@ -109,9 +130,9 @@ - To be added. - To be added. - To be added. + An Index object to compare with this Index object. + Indicates whether the current Index object is equal to another Index object. + if the current Index object is equal to the passed Index object, otherwise. To be added. @@ -138,9 +159,9 @@ - To be added. - To be added. - To be added. + An object to compare with this Index object. + Indicates whether the current Index object is equal to the passed object. + if the current Index object is equal to the passed object, otherwise. To be added. @@ -167,9 +188,9 @@ - To be added. - To be added. - To be added. + The index value from the end. + Create an Index from the end at the position indicated by the value. + The Index value. To be added. @@ -196,9 +217,9 @@ - To be added. - To be added. - To be added. + The index value from the start. + Create an Index from the start at the position indicated by the value. + The index value. To be added. @@ -223,8 +244,8 @@ - To be added. - To be added. + Returns the hash code for this instance. + The hash code. To be added. @@ -251,10 +272,24 @@ - To be added. - To be added. - To be added. - To be added. + The length of the collection that the Index will be used with. Must be a positive value. + Calculate the offset from the start using the giving collection length. + The offset. + + + + + @@ -277,8 +312,8 @@ System.Boolean - To be added. - To be added. + Indicates whether the index is from the start or the end. + A boolean. To be added. @@ -305,9 +340,9 @@ - To be added. - To be added. - To be added. + The integer to convert. + Converts integer number to an Index. + An Index. To be added. @@ -331,8 +366,8 @@ System.Index - To be added. - To be added. + Creates an Index pointing at the first element. + An Index. To be added. @@ -357,8 +392,8 @@ - To be added. - To be added. + Converts the value of the current Index object to its equivalent string representation. + The string representation of the Index. To be added. @@ -382,8 +417,8 @@ System.Int32 - To be added. - To be added. + Returns the index value. + The integer value of the Index. To be added. diff --git a/xml/System/Progress`1.xml b/xml/System/Progress`1.xml index 939cf37d096..f82f8929116 100644 --- a/xml/System/Progress`1.xml +++ b/xml/System/Progress`1.xml @@ -125,6 +125,7 @@ A handler to invoke for each reported progress value. This handler will be invoked in addition to any delegates registered with the event. Depending on the instance captured by the at construction, it is possible that this handler instance could be invoked concurrently with itself. Initializes the object with the specified callback. To be added. + The is (Nothing in Visual Basic). diff --git a/xml/System/Range.xml b/xml/System/Range.xml index bcec175b323..e673e6583e1 100644 --- a/xml/System/Range.xml +++ b/xml/System/Range.xml @@ -27,8 +27,22 @@ - To be added. - To be added. + Represents a range has start and end indexes. + + + + + @@ -52,9 +66,9 @@ - To be added. - To be added. - To be added. + Represents the inclusive start index of the range. + Represents the exclusive end index of the range. + Construct a Range object using the start and end indexes. To be added. @@ -78,8 +92,8 @@ System.Range - To be added. - To be added. + Creates a Range object starting from the first element to the end. + A Range object. To be added. @@ -103,8 +117,8 @@ System.Index - To be added. - To be added. + Represent the exclusive end index of the Range. + An Index. To be added. @@ -131,9 +145,9 @@ - To be added. - To be added. - To be added. + The position of the last element up to which the Range object will be created. + Creates a Range object starting from the first element in the collection to the end Index. + The Range. To be added. @@ -160,9 +174,9 @@ - To be added. - To be added. - To be added. + An object to compare with this Range object. + Indicates whether the current Range object is equal to another object of the same type. + if equal, otherwise. To be added. @@ -192,9 +206,9 @@ - To be added. - To be added. - To be added. + A Range object to compare with this Range object. + Indicates whether the current Range object is equal to another Range object. + if equal, otherwise. To be added. @@ -219,8 +233,8 @@ - To be added. - To be added. + Returns the hash code for this instance. + The hash code. To be added. @@ -247,10 +261,24 @@ - To be added. - To be added. + The length of the collection that the range will be used with. Must be a positive value. + Calculate the start offset and length of range object using a collection length. To be added. - To be added. + + + + + @@ -273,8 +301,8 @@ System.Index - To be added. - To be added. + Represents the inclusive start index of the Range. + An index. To be added. @@ -301,9 +329,9 @@ - To be added. - To be added. - To be added. + The position of the first element from which the Range will be created. + Creates a Range object starting from start index to the end of the collection. + A Range. To be added. @@ -328,8 +356,8 @@ - To be added. - To be added. + Converts the value of the current Range object to its equivalent string representation. + The string representation of the Range. To be added. diff --git a/xml/System/ReadOnlySpan`1.xml b/xml/System/ReadOnlySpan`1.xml index 22f7dbc68b3..99dc3fce40e 100644 --- a/xml/System/ReadOnlySpan`1.xml +++ b/xml/System/ReadOnlySpan`1.xml @@ -144,7 +144,17 @@ A `ReadOnlySpan` instance is often used to reference the elements of an array The index of the first element to include. The number of elements to include. Creates a new that includes a specified number of elements of an array starting at a specified index. - To be added. + + + is `null`. + + ]]> + + is , but or is non-zero. diff --git a/xml/System/SequencePosition.xml b/xml/System/SequencePosition.xml index 880aa3aa05e..06e92d1e580 100644 --- a/xml/System/SequencePosition.xml +++ b/xml/System/SequencePosition.xml @@ -29,7 +29,7 @@ - To be added. + Represents a position in a non-contiguous set of memory. Properties of this type should not be interpreted by anything but the type that created it. To be added. @@ -57,7 +57,7 @@ To be added. To be added. - To be added. + Creates a new . To be added. @@ -92,9 +92,17 @@ To be added. - To be added. - To be added. - To be added. + Indicates whether the current is equal to another of the same type. + if equal, otherwise. + + equality does not guarantee that they point to the same location in . + + ]]> + @@ -126,9 +134,18 @@ To be added. - To be added. - To be added. - To be added. + Indicates whether the current is equal to another . + if equal, otherwise. + + equality does not guarantee that they point to the same location in . + + ]]> + + @@ -192,8 +209,8 @@ - To be added. - To be added. + Returns the integer part of this . + The integer part of this sequence position. To be added. @@ -225,8 +242,8 @@ - To be added. - To be added. + Returns the object part of this . + The object part of this sequence position. To be added. diff --git a/xml/System/Single.xml b/xml/System/Single.xml index 7556dadea11..652c1cf2042 100644 --- a/xml/System/Single.xml +++ b/xml/System/Single.xml @@ -862,9 +862,9 @@ - To be added. - To be added. - To be added. + A single-precision floating-point number. + Determines whether the specified value is finite (zero, subnormal or normal). + if the specified value is finite (zero, subnormal or normal). To be added. @@ -1033,9 +1033,9 @@ - To be added. - To be added. - To be added. + A single-precision floating-point number. + Determines whether the specified value is negative. + if negative, otherwise. To be added. @@ -1133,9 +1133,9 @@ - To be added. - To be added. - To be added. + A single-precision floating-point number. + Determines whether the specified value is normal. + if normal, otherwise. To be added. @@ -1233,9 +1233,9 @@ - To be added. - To be added. - To be added. + A single-precision floating-point number. + Determines whether the specified value is subnormal. + if subnormal, otherwise. To be added. diff --git a/xml/System/Span`1.xml b/xml/System/Span`1.xml index d15e27100a3..ba30eb62a56 100644 --- a/xml/System/Span`1.xml +++ b/xml/System/Span`1.xml @@ -200,7 +200,17 @@ If `array` is `null`, this constructor returns a `null` `Span`. The index of the first element to include in the new . The number of elements to include in the new . Creates a new object that includes a specified number of elements of an array starting at a specified index. - To be added. + + + is `null`. + + ]]> + + is , but or is non-zero. @@ -1106,4 +1116,4 @@ If `destination` is shorter than the source , this method - + \ No newline at end of file diff --git a/xml/System/String.xml b/xml/System/String.xml index 85efebb00e0..6675eb2cbdd 100644 --- a/xml/System/String.xml +++ b/xml/System/String.xml @@ -4762,9 +4762,19 @@ Depending on Why you want to call the `Copy` method, there are a number of alter - To be added. - To be added. - To be added. + Returns an enumeration of from this string. + A string rune enumerator. + + + . + + ]]> + + @@ -6413,9 +6423,10 @@ String 'This is a string.' in domain 'NewDomain': 75CC8236 - To be added. - To be added. + Returns a reference to the first element of the String. + A pinnable reference as a readonly char. To be added. + If the string is . diff --git a/xml/System/ValueTuple.xml b/xml/System/ValueTuple.xml index f234c04c44b..2533e5eecfc 100644 --- a/xml/System/ValueTuple.xml +++ b/xml/System/ValueTuple.xml @@ -1124,7 +1124,17 @@ The type is not serializable in .NET Core 1.x or in the Returns the string representation of this instance. This method always returns "()". - To be added. + + + + + diff --git a/xml/System/ValueTuple`2.xml b/xml/System/ValueTuple`2.xml index 30f00d1b2e2..4def0411ba9 100644 --- a/xml/System/ValueTuple`2.xml +++ b/xml/System/ValueTuple`2.xml @@ -513,7 +513,20 @@ The type is not serializable in .NET Core 1.x or in Returns a value that indicates whether the current instance is equal to a specified object based on a specified comparison method. if the current instance is equal to the specified objects; otherwise, . - To be added. + + + instance is cast to an interface. + +The implementation is called only if `other` is not `null`, and if it can be successfully cast (in C#) or converted (in Visual Basic) to a whose components are of the same types as those of the current instance. The IStructuralEquatable.Equals(Object, IEqualityComparer) method first passes the values of the objects to be compared to the implementation. If this method call returns `true`, the method is +called again and passed the values of the two instances. + + ]]> + + From 1c78edf687a1af27f678400f3d38121a48e032ae Mon Sep 17 00:00:00 2001 From: carlossanlop Date: Tue, 16 Jul 2019 13:54:04 -0700 Subject: [PATCH 02/19] Various fixes --- xml/System/FormattableString.xml | 6 +++++- xml/System/Index.xml | 16 +++++++++------- xml/System/Range.xml | 14 ++++++++------ xml/System/ReadOnlySpan`1.xml | 2 +- xml/System/Span`1.xml | 2 +- 5 files changed, 24 insertions(+), 16 deletions(-) diff --git a/xml/System/FormattableString.xml b/xml/System/FormattableString.xml index 173d779ce04..086ba453cc7 100644 --- a/xml/System/FormattableString.xml +++ b/xml/System/FormattableString.xml @@ -153,11 +153,15 @@ This static method may be imported in C# by: +```cs using static System.FormattableString; +``` Within the scope of that import directive an interpolated string may be formatted in the current culture by writing, for example: - CurrentCulture($"{{ lat = {latitude}; lon = {longitude} }}") +```cs + CurrentCulture($"{{ lat = {latitude}; lon = {longitude} }}"); +``` ]]>. diff --git a/xml/System/Index.xml b/xml/System/Index.xml index 9f9c62c9592..a314b818181 100644 --- a/xml/System/Index.xml +++ b/xml/System/Index.xml @@ -35,8 +35,10 @@ Index is used by the C# compiler to support the new index syntax: - int[] someArray = new int[5] { 1, 2, 3, 4, 5 } ; +```cs + int[] someArray = new int[5] { 1, 2, 3, 4, 5 }; int lastElement = someArray[^1]; // lastElement = 5 +``` ]]> @@ -281,11 +283,11 @@ If the Index constructed from the end, index value 1 means pointing at the last ### Remarks -For performance reason, we don't validate the input length parameter and the returned offset value against negative values. +For performance reasons, we don't validate the input length parameter and the returned offset value against negative values. -we don't validate either the returned offset is greater than the input length. +We also don't validate if the returned offset is greater than the input length. -It is expected Index will be used with collections which always have non negative length/count. If the returned offset is negative and then used to index a collection will get out of range exception which will be same affect as the validation. +It is expected that Index will always be used with collections have non negative length/count. If the returned offset is negative and then used to index, a collection will throw range exception which will be the same effect as the validation. ]]> @@ -313,7 +315,7 @@ It is expected Index will be used with collections which always have non negativ Indicates whether the index is from the start or the end. - A boolean. + if the Index is from the end, if it's not. To be added. @@ -342,7 +344,7 @@ It is expected Index will be used with collections which always have non negativ The integer to convert. Converts integer number to an Index. - An Index. + An Index representing the integer. To be added. @@ -367,7 +369,7 @@ It is expected Index will be used with collections which always have non negativ Creates an Index pointing at the first element. - An Index. + An Index of the first element. To be added. diff --git a/xml/System/Range.xml b/xml/System/Range.xml index e673e6583e1..96ee6d4b941 100644 --- a/xml/System/Range.xml +++ b/xml/System/Range.xml @@ -36,10 +36,12 @@ Range is used by the C# compiler to support the range syntax. +```cs int[] someArray = new int[5] { 1, 2, 3, 4, 5 }; - int[] subArray1 = someArray[0..2]; // { 1, 2 } - int[] subArray2 = someArray[1..^0]; // { 2, 3, 4, 5 } - + int[] subArray1 = someArray[0..2]; // { 1, 2 } + int[] subArray2 = someArray[1..^0]; // { 2, 3, 4, 5 } +``` + ]]> @@ -270,11 +272,11 @@ Range is used by the C# compiler to support the range syntax. ### Remarks -For performance reason, we don't validate the input length parameter against negative values. +For performance reasons, we don't validate the input length parameter against negative values. -It is expected Range will be used with collections which always have non negative length/count. +It is expected that Range will always be used with collections that have non negative length/count. -We validate the range is inside the length scope though. +We do validate that the Range is within length scope. ]]> diff --git a/xml/System/ReadOnlySpan`1.xml b/xml/System/ReadOnlySpan`1.xml index 99dc3fce40e..3345aa582d8 100644 --- a/xml/System/ReadOnlySpan`1.xml +++ b/xml/System/ReadOnlySpan`1.xml @@ -150,7 +150,7 @@ A `ReadOnlySpan` instance is often used to reference the elements of an array ### Remarks -Returns `default` when is `null`. +Returns `default` when `array` is `null`. ]]> diff --git a/xml/System/Span`1.xml b/xml/System/Span`1.xml index ba30eb62a56..959cebcaec9 100644 --- a/xml/System/Span`1.xml +++ b/xml/System/Span`1.xml @@ -206,7 +206,7 @@ If `array` is `null`, this constructor returns a `null` `Span`. ### Remarks -Returns `default` when is `null`. +Returns `default` when `array` is `null`. ]]> From 3b193fc0863f6d72e58b4010b538af25b905d667 Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Thu, 18 Jul 2019 11:16:12 -0700 Subject: [PATCH 03/19] Update Range.xml --- xml/System/Range.xml | 65 +++++++++++++++++++++----------------------- 1 file changed, 31 insertions(+), 34 deletions(-) diff --git a/xml/System/Range.xml b/xml/System/Range.xml index 96ee6d4b941..0ff4638eb80 100644 --- a/xml/System/Range.xml +++ b/xml/System/Range.xml @@ -27,16 +27,16 @@ - Represents a range has start and end indexes. + Represents a range that has start and end indexes. - Represents the inclusive start index of the range. - Represents the exclusive end index of the range. - Construct a Range object using the start and end indexes. + The inclusive start index of the range. + The exclusive end index of the range. + Instantiates a new instance with the specified starting and ending indexes. To be added. @@ -94,8 +94,8 @@ Range is used by the C# compiler to support the range syntax. System.Range - Creates a Range object starting from the first element to the end. - A Range object. + Gets a object that starts from the first element to the end. + A range from the start to the end. To be added. @@ -119,8 +119,8 @@ Range is used by the C# compiler to support the range syntax. System.Index - Represent the exclusive end index of the Range. - An Index. + Gets an that represents the exclusive end index of the range. + The end index of the range. To be added. @@ -147,9 +147,9 @@ Range is used by the C# compiler to support the range syntax. - The position of the last element up to which the Range object will be created. - Creates a Range object starting from the first element in the collection to the end Index. - The Range. + The position of the last element up to which the object will be created. + Creates a object starting from the first element in the collection to a specified end index. + A range that starts from the first element to . To be added. @@ -177,8 +177,8 @@ Range is used by the C# compiler to support the range syntax. An object to compare with this Range object. - Indicates whether the current Range object is equal to another object of the same type. - if equal, otherwise. + Returns a value that indicates whether the current instance is equal to a specified object. + if is of type and is equal to the current instance; otherwise, . To be added. @@ -193,7 +193,7 @@ Range is used by the C# compiler to support the range syntax. M:System.IEquatable`1.Equals(`0) - + R System.Runtime 4.2.1.0 @@ -209,8 +209,8 @@ Range is used by the C# compiler to support the range syntax. A Range object to compare with this Range object. - Indicates whether the current Range object is equal to another Range object. - if equal, otherwise. + Returns a value that indicates whether the current instance is equal to another object. + if the current instance is equal to ; otherwise, . To be added. @@ -263,24 +263,21 @@ Range is used by the C# compiler to support the range syntax. - The length of the collection that the range will be used with. Must be a positive value. - Calculate the start offset and length of range object using a collection length. - To be added. + A positive integer that represents the length of the collection that the range will be used with. + Returns a instance with the starting offset and length of a range. + The starting offset and length of the range. + is outside the bounds of the current range. @@ -303,8 +300,8 @@ We do validate that the Range is within length scope. System.Index - Represents the inclusive start index of the Range. - An index. + Gets the inclusive start index of the . + The inclusive start index of the range. To be added. @@ -332,8 +329,8 @@ We do validate that the Range is within length scope. The position of the first element from which the Range will be created. - Creates a Range object starting from start index to the end of the collection. - A Range. + Returns a new instance starting from a specified start index to the end of the collection. + A range from to the end of the collection. To be added. @@ -358,10 +355,10 @@ We do validate that the Range is within length scope. - Converts the value of the current Range object to its equivalent string representation. - The string representation of the Range. + Returns the string representation of the current object. + The string representation of the range. To be added. - \ No newline at end of file + From cc0ec5f86ec0271ee6f652009392c69fbddcefce Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Thu, 18 Jul 2019 12:25:00 -0700 Subject: [PATCH 04/19] Update SequencePosition.xml --- xml/System/SequencePosition.xml | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/xml/System/SequencePosition.xml b/xml/System/SequencePosition.xml index 06e92d1e580..cbd6378cf6d 100644 --- a/xml/System/SequencePosition.xml +++ b/xml/System/SequencePosition.xml @@ -55,8 +55,8 @@ - To be added. - To be added. + A non-contiguous set of memory. + The position in . Creates a new . To be added. @@ -91,15 +91,15 @@ - To be added. - Indicates whether the current is equal to another of the same type. - if equal, otherwise. + The object to compare with the current instance. + Returns a value that indicates whether the current instance is equal to another object. + if is of type and is equal to the current instance; otherwise, . equality does not guarantee that they point to the same location in . +Equality does not guarantee that the two instances point to the same location in a . ]]> @@ -133,15 +133,15 @@ - To be added. - Indicates whether the current is equal to another . - if equal, otherwise. + The object to compare with the current instance. + Indicates whether the current instance is equal to another . + if the two instances are equal; otherwise. equality does not guarantee that they point to the same location in . +Equality does not guarantee that the two instances point to the same location in a . ]]> @@ -176,8 +176,8 @@ - To be added. - To be added. + Returns the hash code for this instance. + The hash code for this instance. To be added. @@ -248,4 +248,4 @@ - \ No newline at end of file + From c994b6450f44fa32b0873b95c021162ebb915415 Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Thu, 18 Jul 2019 12:29:08 -0700 Subject: [PATCH 05/19] Update Single.xml --- xml/System/Single.xml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/xml/System/Single.xml b/xml/System/Single.xml index 652c1cf2042..eb6a95a23ce 100644 --- a/xml/System/Single.xml +++ b/xml/System/Single.xml @@ -864,7 +864,7 @@ A single-precision floating-point number. Determines whether the specified value is finite (zero, subnormal or normal). - if the specified value is finite (zero, subnormal or normal). + if the specified value is finite (zero, subnormal or normal); otherwise, . To be added. @@ -1135,7 +1135,7 @@ A single-precision floating-point number. Determines whether the specified value is normal. - if normal, otherwise. + if is normal; otherwise. To be added. @@ -1235,7 +1235,7 @@ A single-precision floating-point number. Determines whether the specified value is subnormal. - if subnormal, otherwise. + if is subnormal; otherwise. To be added. @@ -3914,4 +3914,4 @@ - \ No newline at end of file + From 6aefa09f4e5f0309070a01c81a580ac5dc629018 Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Thu, 18 Jul 2019 12:30:14 -0700 Subject: [PATCH 06/19] Update Span`1.xml --- xml/System/Span`1.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/System/Span`1.xml b/xml/System/Span`1.xml index 959cebcaec9..5c56d5dfe44 100644 --- a/xml/System/Span`1.xml +++ b/xml/System/Span`1.xml @@ -206,7 +206,7 @@ If `array` is `null`, this constructor returns a `null` `Span`. ### Remarks -Returns `default` when `array` is `null`. +This method returns `default` when `array` is `null`. ]]> @@ -1116,4 +1116,4 @@ If `destination` is shorter than the source , this method - \ No newline at end of file + From 731c14cb80f56c87a8739d1ce4235cb46d489d99 Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Thu, 18 Jul 2019 12:38:09 -0700 Subject: [PATCH 07/19] Update ValueTuple.xml --- xml/System/ValueTuple.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/System/ValueTuple.xml b/xml/System/ValueTuple.xml index 2533e5eecfc..9126a3dca32 100644 --- a/xml/System/ValueTuple.xml +++ b/xml/System/ValueTuple.xml @@ -1128,7 +1128,7 @@ The type is not serializable in .NET Core 1.x or in the - \ No newline at end of file + From ce54d354109c5a32fbadbeed4b35ef49c963e35a Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Thu, 18 Jul 2019 12:51:41 -0700 Subject: [PATCH 08/19] Update ValueTuple`2.xml --- xml/System/ValueTuple`2.xml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/xml/System/ValueTuple`2.xml b/xml/System/ValueTuple`2.xml index 4def0411ba9..2e3546845c0 100644 --- a/xml/System/ValueTuple`2.xml +++ b/xml/System/ValueTuple`2.xml @@ -521,8 +521,7 @@ The type is not serializable in .NET Core 1.x or in This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. -The implementation is called only if `other` is not `null`, and if it can be successfully cast (in C#) or converted (in Visual Basic) to a whose components are of the same types as those of the current instance. The IStructuralEquatable.Equals(Object, IEqualityComparer) method first passes the values of the objects to be compared to the implementation. If this method call returns `true`, the method is -called again and passed the values of the two instances. +The implementation is called only if `other` is not `null`, and if it can be successfully cast to a whose components are of the same types as those of the current instance. The method first passes the values of the objects to be compared to the implementation. If this method call returns `true`, the method is called again and passed the values of the two instances. ]]> @@ -768,4 +767,4 @@ called again and passed the values of the two < - \ No newline at end of file + From 0105f1a8e6ff3e62d6be57f378d4d35ef910f371 Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Thu, 18 Jul 2019 16:43:02 -0700 Subject: [PATCH 09/19] Corrected malformed xml. --- xml/System/SequencePosition.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System/SequencePosition.xml b/xml/System/SequencePosition.xml index cbd6378cf6d..0b2afa02299 100644 --- a/xml/System/SequencePosition.xml +++ b/xml/System/SequencePosition.xml @@ -56,7 +56,7 @@ A non-contiguous set of memory. - The position in . + The position in . Creates a new . To be added. From 95ccebe3bcbe6c664a5b36a14a196f00a1429974 Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Thu, 18 Jul 2019 16:46:43 -0700 Subject: [PATCH 10/19] corrected malformed xml --- xml/System/Single.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System/Single.xml b/xml/System/Single.xml index eb6a95a23ce..1e76f4c3b89 100644 --- a/xml/System/Single.xml +++ b/xml/System/Single.xml @@ -1135,7 +1135,7 @@ A single-precision floating-point number. Determines whether the specified value is normal. - if is normal; otherwise. + if is normal; otherwise. To be added. From 816e6f0cf867e3fb6fd9ffaeaf8ab13d20c3562c Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Thu, 18 Jul 2019 22:43:35 -0700 Subject: [PATCH 11/19] Update xml/System/AggregateException.xml Co-Authored-By: Ron Petrusha --- xml/System/AggregateException.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/System/AggregateException.xml b/xml/System/AggregateException.xml index 793c55c3c94..a88ecc20d27 100644 --- a/xml/System/AggregateException.xml +++ b/xml/System/AggregateException.xml @@ -729,7 +729,7 @@ Gets a message that describes the exception. - A string representing the message that describes the exception. + The message that describes the exception. To be added. @@ -772,4 +772,4 @@ - \ No newline at end of file + From ac2c27ff2b637e5e6e3f75b132a620ffd1bd52b4 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Thu, 18 Jul 2019 22:44:27 -0700 Subject: [PATCH 12/19] Double.xml Co-Authored-By: Ron Petrusha --- xml/System/Double.xml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/xml/System/Double.xml b/xml/System/Double.xml index 265c348be38..05906245c8e 100644 --- a/xml/System/Double.xml +++ b/xml/System/Double.xml @@ -852,7 +852,7 @@ A double-precision floating-point number. Determines whether the specified value is finite (zero, subnormal, or normal). - if the value is finite (zero, subnormal or normal), otherwise. + if the value is finite (zero, subnormal or normal); otherwise. To be added. @@ -1023,7 +1023,7 @@ A double-precision floating-point number. Determines whether the specified value is negative. - if the value is negative, otherwise. + if the value is negative; otherwise. To be added. @@ -1124,7 +1124,7 @@ A double-precision floating-point number. Determines whether the specified value is normal. - if the value is normal, otherwise. + if the value is normal; otherwise. To be added. @@ -1219,7 +1219,7 @@ A double-precision floating-point number. Determines whether the specified value is subnormal. - if the value is subnormal, otherwise. + if the value is subnormal; otherwise. To be added. @@ -3915,4 +3915,4 @@ - \ No newline at end of file + From c8e643b9f4e572ae9033fe5c55706409d5f2d842 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Thu, 18 Jul 2019 22:45:21 -0700 Subject: [PATCH 13/19] FormattableString.xml Co-Authored-By: Ron Petrusha --- xml/System/FormattableString.xml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/xml/System/FormattableString.xml b/xml/System/FormattableString.xml index 086ba453cc7..aaa6dc4c1ad 100644 --- a/xml/System/FormattableString.xml +++ b/xml/System/FormattableString.xml @@ -143,8 +143,8 @@ The string to be formatted. - Format the given object in the current culture. - The formatted string in the current culture. + Returns a result string in which arguments are formatted by using the conventions of the current culture. + The string that results from formatting the current instance by using the conventions of the current culture. - \ No newline at end of file + From b8caade38322553be024636056608d6645046c62 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Thu, 18 Jul 2019 22:47:16 -0700 Subject: [PATCH 14/19] Index.xml Co-Authored-By: Ron Petrusha --- xml/System/Index.xml | 57 ++++++++++++++++++++++---------------------- 1 file changed, 28 insertions(+), 29 deletions(-) diff --git a/xml/System/Index.xml b/xml/System/Index.xml index a314b818181..a2755b42150 100644 --- a/xml/System/Index.xml +++ b/xml/System/Index.xml @@ -33,9 +33,9 @@ ### Remarks -Index is used by the C# compiler to support the new index syntax: +`Index` is used by the C# compiler to support the new index syntax: -```cs +```csharp int[] someArray = new int[5] { 1, 2, 3, 4, 5 }; int lastElement = someArray[^1]; // lastElement = 5 ``` @@ -66,15 +66,15 @@ Index is used by the C# compiler to support the new index syntax: The index value. It has to be greater or equal than zero. - A boolean indicating if the index is from the start or from the end . - Construct an Index using a value and indicating if the index is from the start or from the end. + A boolean indicating if the index is from the start () or from the end () of a collection. + Initializes a new with a specified index position and a value that indicates if the index is from the start or the end of a collection. is constructed from the end, an index value of 1 points to the last element, and an index value of 0 points beyond last element. ]]> @@ -101,8 +101,8 @@ If the Index constructed from the end, index value 1 means pointing at the last System.Index - Create an Index pointing at beyond last element. - The Index pointing at beyond last element. + Gets an that points beyond the last element. + an that points beyond the last element. To be added. @@ -132,9 +132,9 @@ If the Index constructed from the end, index value 1 means pointing at the last - An Index object to compare with this Index object. - Indicates whether the current Index object is equal to another Index object. - if the current Index object is equal to the passed Index object, otherwise. + The object to compare with this instance. + Returns a value that indicates whether the current object is equal to another object. + if the current Index object is equal to ; otherwise. To be added. @@ -161,9 +161,9 @@ If the Index constructed from the end, index value 1 means pointing at the last - An object to compare with this Index object. - Indicates whether the current Index object is equal to the passed object. - if the current Index object is equal to the passed object, otherwise. + An object to compare with this instance. + Indicates whether the current Index object is equal to a specified object. + if is of type and is equal to the current instance; otherwise. To be added. @@ -190,8 +190,8 @@ If the Index constructed from the end, index value 1 means pointing at the last - The index value from the end. - Create an Index from the end at the position indicated by the value. + The index value from the end of a collection. + Creates an from the end of a collection at a specified index position. The Index value. To be added. @@ -219,8 +219,8 @@ If the Index constructed from the end, index value 1 means pointing at the last - The index value from the start. - Create an Index from the start at the position indicated by the value. + The index position from the start of a collection. + Create an from the specified index at the start of a collection. The index value. To be added. @@ -281,11 +281,10 @@ If the Index constructed from the end, index value 1 means pointing at the last System.Boolean - Indicates whether the index is from the start or the end. - if the Index is from the end, if it's not. + Gets a value that indicates whether the index is from the start or the end. + if the Index is from the end; otherwise, . To be added. @@ -368,8 +367,8 @@ It is expected that Index will always be used with collections have non negative System.Index - Creates an Index pointing at the first element. - An Index of the first element. + Gets an that points to the first element of a collection. + An instance that points to the first element of a collection. To be added. @@ -394,8 +393,8 @@ It is expected that Index will always be used with collections have non negative - Converts the value of the current Index object to its equivalent string representation. - The string representation of the Index. + Returns the string representation of the current instance. + The string representation of the . To be added. @@ -419,10 +418,10 @@ It is expected that Index will always be used with collections have non negative System.Int32 - Returns the index value. - The integer value of the Index. + Gets the index value. + The index value. To be added. - \ No newline at end of file + From 2da3c3f52bea128ec02effe32ee822469b253a68 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Thu, 18 Jul 2019 22:47:38 -0700 Subject: [PATCH 15/19] Progress.xml Co-Authored-By: Ron Petrusha --- xml/System/Progress`1.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/System/Progress`1.xml b/xml/System/Progress`1.xml index f82f8929116..3d2de3286ee 100644 --- a/xml/System/Progress`1.xml +++ b/xml/System/Progress`1.xml @@ -125,7 +125,7 @@ A handler to invoke for each reported progress value. This handler will be invoked in addition to any delegates registered with the event. Depending on the instance captured by the at construction, it is possible that this handler instance could be invoked concurrently with itself. Initializes the object with the specified callback. To be added. - The is (Nothing in Visual Basic). + is ( in Visual Basic). @@ -248,4 +248,4 @@ - \ No newline at end of file + From cd3d7185c2d04508bedb1a57ef522957e544d198 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Thu, 18 Jul 2019 22:48:20 -0700 Subject: [PATCH 16/19] ReadOnlySpan.xml Co-Authored-By: Ron Petrusha --- xml/System/ReadOnlySpan`1.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/System/ReadOnlySpan`1.xml b/xml/System/ReadOnlySpan`1.xml index 3345aa582d8..56950a4b5f7 100644 --- a/xml/System/ReadOnlySpan`1.xml +++ b/xml/System/ReadOnlySpan`1.xml @@ -150,7 +150,7 @@ A `ReadOnlySpan` instance is often used to reference the elements of an array ### Remarks -Returns `default` when `array` is `null`. +This method returns `default` when `array` is `null`. ]]> @@ -898,4 +898,4 @@ If the `destination` length is shorter than `source`, no items are copied and th - \ No newline at end of file + From 50f2db25f3e244164ad0704e715b365596b30f36 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez Date: Thu, 18 Jul 2019 23:01:34 -0700 Subject: [PATCH 17/19] String.xml --- xml/System/String.xml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/xml/System/String.xml b/xml/System/String.xml index 6675eb2cbdd..9034900baba 100644 --- a/xml/System/String.xml +++ b/xml/System/String.xml @@ -4770,7 +4770,7 @@ Depending on Why you want to call the `Copy` method, there are a number of alter ### Remarks -Invalid sequences will be represented in the enumeration by . +Invalid sequences are represented in the enumeration by . ]]> @@ -6423,10 +6423,10 @@ String 'This is a string.' in domain 'NewDomain': 75CC8236 - Returns a reference to the first element of the String. - A pinnable reference as a readonly char. + Returns a reference to the first element of the string. + A pinnable reference to the first element of the string as a read-only char. To be added. - If the string is . + The string is . From 8c4741d8be734d8b2ed11d5189e3cae42032994e Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Date: Tue, 23 Jul 2019 17:12:18 -0700 Subject: [PATCH 18/19] varied suggestions --- xml/System/Index.xml | 6 +++--- xml/System/Range.xml | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/xml/System/Index.xml b/xml/System/Index.xml index a2755b42150..0625fe8ddfd 100644 --- a/xml/System/Index.xml +++ b/xml/System/Index.xml @@ -275,7 +275,7 @@ If the is constructed from the end, an index value The length of the collection that the Index will be used with. Must be a positive value. - Calculate the offset from the start using the giving collection length. + Calculate the offset from the start using the given collection length. The offset. @@ -283,10 +283,10 @@ If the is constructed from the end, an index value ## Remarks -For performance reasons, this method does not test whether `length` or the return value is negative. It also doesn't test whether the return value is greater than `length`. +For performance reasons, this method does not validate if `length` or the returned value are negative. It also doesn't validate if the returned value is greater than `length`. -It is expected that Index will always be used with collections have non negative length/count. If the returned offset is negative and then used to index, a collection will throw range exception which will be the same effect as the validation. +Collections are not expected to have a non-negative length/count. If this method's returned offset is negative and then used to index a collection, the collection will throw , which will have the same effect as validation. ]]> diff --git a/xml/System/Range.xml b/xml/System/Range.xml index 0ff4638eb80..e85993a001f 100644 --- a/xml/System/Range.xml +++ b/xml/System/Range.xml @@ -193,7 +193,7 @@ M:System.IEquatable`1.Equals(`0) - R + System.Runtime 4.2.1.0 From acbc62c141fcdcd210f630f019edf198a6d5a48d Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Wed, 24 Jul 2019 12:27:21 -0700 Subject: [PATCH 19/19] Minor changes. --- xml/System/Index.xml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/xml/System/Index.xml b/xml/System/Index.xml index 0625fe8ddfd..1f9e6ddb058 100644 --- a/xml/System/Index.xml +++ b/xml/System/Index.xml @@ -275,7 +275,7 @@ If the is constructed from the end, an index value The length of the collection that the Index will be used with. Must be a positive value. - Calculate the offset from the start using the given collection length. + Calculates the offset from the start using the given collection length. The offset. @@ -285,8 +285,7 @@ If the is constructed from the end, an index value For performance reasons, this method does not validate if `length` or the returned value are negative. It also doesn't validate if the returned value is greater than `length`. - -Collections are not expected to have a non-negative length/count. If this method's returned offset is negative and then used to index a collection, the collection will throw , which will have the same effect as validation. +Collections are not expected to have a non-negative length/count. If this method's returned offset is negative and is then used to index a collection, the runtime will throw , which will have the same effect as validation. ]]>