From 42022c48458ec6e02b70db1de069080c3ed5a1b7 Mon Sep 17 00:00:00 2001 From: Carlos Sanchez Lopez Date: Fri, 1 Nov 2019 19:29:18 -0700 Subject: [PATCH 1/2] Document TryParse Span methods overloads for Boolean, Byte, DateTime, DateTimeoffset, Decimal, Double, Enum, Guid --- xml/System/Boolean.xml | 13 ++++++------- xml/System/Byte.xml | 28 +++++++++++++--------------- xml/System/DateTime.xml | 24 +++++++++++------------- xml/System/DateTimeOffset.xml | 26 ++++++++++++-------------- xml/System/Decimal.xml | 25 ++++++++++++------------- xml/System/Double.xml | 23 +++++++++++------------ xml/System/Enum.xml | 22 +++++++++++----------- xml/System/Guid.xml | 11 +++++------ 8 files changed, 81 insertions(+), 91 deletions(-) diff --git a/xml/System/Boolean.xml b/xml/System/Boolean.xml index 2ea59908470..18c164a35aa 100644 --- a/xml/System/Boolean.xml +++ b/xml/System/Boolean.xml @@ -1822,10 +1822,10 @@ - To be added. - To be added. - To be added. - To be added. + A span containing the characters representing the value to convert. + When this method returns, if the conversion succeeded, contains if is equal to or if is equal to . If the conversion failed, contains . The conversion fails if is or is not equal to the value of either the or field. + Tries to convert the specified readonly char span representation of a logical value to its equivalent. + if was converted successfully; otherwise, . To be added. @@ -1867,9 +1867,8 @@ A string containing the value to convert. When this method returns, if the conversion succeeded, contains if is equal to or if is equal to . If the conversion failed, contains . The conversion fails if is or is not equal to the value of either the or field. - Tries to convert the specified string representation of a logical value to its equivalent. A return value indicates whether the conversion succeeded or failed. - - if was converted successfully; otherwise, . + Tries to convert the specified string representation of a logical value to its equivalent. + if was converted successfully; otherwise, . - To be added. - To be added. - To be added. - To be added. + A span containing the characters representing the number to convert. + When this method returns, contains the value equivalent to the number contained in if the conversion succeeded, or zero if the conversion failed. This parameter is passed uninitialized; any value originally supplied in will be overwritten. + Tries to convert the readonly char span representation of a number to its equivalent, and returns a value that indicates whether the conversion succeeded. + if was converted successfully; otherwise, . To be added. @@ -2394,11 +2394,10 @@ - A string that contains a number to convert. The string is interpreted using the style. + A string that contains a number to convert. When this method returns, contains the value equivalent to the number contained in if the conversion succeeded, or zero if the conversion failed. This parameter is passed uninitialized; any value originally supplied in will be overwritten. Tries to convert the string representation of a number to its equivalent, and returns a value that indicates whether the conversion succeeded. - - if was converted successfully; otherwise, . + if was converted successfully; otherwise, . - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + A span containing the characters representing the number to convert. The span is interpreted using the style. + A bitwise combination of enumeration values that indicates the style elements that can be present in . A typical value to specify is . + An object that supplies culture-specific formatting information about . If is , the thread current culture is used. + When this method returns, contains the 8-bit unsigned integer value equivalent to the number contained in if the conversion succeeded, or zero if the conversion failed. The conversion fails if the parameter is or , is not of the correct format, or represents a number less than or greater than . This parameter is passed uninitialized; any value originally supplied in will be overwritten. + Converts the readonly char span representation of a number in a specified style and culture-specific format to its equivalent. A return value indicates whether the conversion succeeded or failed. + if was converted successfully; otherwise, . To be added. @@ -2523,8 +2522,7 @@ An object that supplies culture-specific formatting information about . If is , the thread current culture is used. When this method returns, contains the 8-bit unsigned integer value equivalent to the number contained in if the conversion succeeded, or zero if the conversion failed. The conversion fails if the parameter is or , is not of the correct format, or represents a number less than or greater than . This parameter is passed uninitialized; any value originally supplied in will be overwritten. Converts the string representation of a number in a specified style and culture-specific format to its equivalent. A return value indicates whether the conversion succeeded or failed. - - if was converted successfully; otherwise, . + if was converted successfully; otherwise, . object is formatted using the pa - To be added. - To be added. + A string containing a date and time to convert. + When this method returns, contains the value equivalent to the date and time contained in , if the conversion succeeded, or if the conversion failed. The conversion fails if the parameter is , is an empty string (""), or does not contain a valid string representation of a date and time. This parameter is passed uninitialized. To be added. - To be added. + if the parameter was converted successfully; otherwise, . To be added. @@ -8151,8 +8151,7 @@ The value of the current object is formatted using the pa A string containing a date and time to convert. When this method returns, contains the value equivalent to the date and time contained in , if the conversion succeeded, or if the conversion failed. The conversion fails if the parameter is , is an empty string (""), or does not contain a valid string representation of a date and time. This parameter is passed uninitialized. Converts the specified string representation of a date and time to its equivalent and returns a value that indicates whether the conversion succeeded. - - if the parameter was converted successfully; otherwise, . + if the parameter was converted successfully; otherwise, . object is formatted using the pa - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + A span containing the characters representing the date and time to convert. + An object that supplies culture-specific formatting information about . + A bitwise combination of enumeration values that defines how to interpret the parsed date in relation to the current time zone or the current date. A typical value to specify is . + When this method returns, contains the value equivalent to the date and time contained in , if the conversion succeeded, or if the conversion failed. The conversion fails if the parameter is , is an empty string (""), or does not contain a valid string representation of a date and time. This parameter is passed uninitialized. + Converts the specified readonly char span representation of a date and time to its equivalent using the specified culture-specific format information and formatting style, and returns a value that indicates whether the conversion succeeded. + if the parameter was converted successfully; otherwise, . To be added. @@ -8279,8 +8278,7 @@ The value of the current object is formatted using the pa A bitwise combination of enumeration values that defines how to interpret the parsed date in relation to the current time zone or the current date. A typical value to specify is . When this method returns, contains the value equivalent to the date and time contained in , if the conversion succeeded, or if the conversion failed. The conversion fails if the parameter is , is an empty string (""), or does not contain a valid string representation of a date and time. This parameter is passed uninitialized. Converts the specified string representation of a date and time to its equivalent using the specified culture-specific format information and formatting style, and returns a value that indicates whether the conversion succeeded. - - if the parameter was converted successfully; otherwise, . + if the parameter was converted successfully; otherwise, . - To be added. - To be added. - To be added. - To be added. + A span containing the characters representing the date and time to convert. + When the method returns, contains the equivalent to the date and time of , if the conversion succeeded, or , if the conversion failed. The conversion fails if the parameter is or does not contain a valid string representation of a date and time. This parameter is passed uninitialized. + Tries to convert a specified readonly char span representation of a date and time to its equivalent, and returns a value that indicates whether the conversion succeeded. + if the parameter is successfully converted; otherwise, . To be added. @@ -5456,8 +5456,7 @@ Me.ToUtcDateTime().ToFileTime() A string that contains a date and time to convert. When the method returns, contains the equivalent to the date and time of , if the conversion succeeded, or , if the conversion failed. The conversion fails if the parameter is or does not contain a valid string representation of a date and time. This parameter is passed uninitialized. Tries to converts a specified string representation of a date and time to its equivalent, and returns a value that indicates whether the conversion succeeded. - - if the parameter is successfully converted; otherwise, . + if the parameter is successfully converted; otherwise, . - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + A span containing the characters representing the date and time to convert. + An object that provides culture-specific formatting information about . + A bitwise combination of enumeration values that indicates the permitted format of . + When the method returns, contains the value equivalent to the date and time of , if the conversion succeeded, or , if the conversion failed. The conversion fails if the parameter is or does not contain a valid string representation of a date and time. This parameter is passed uninitialized. + Tries to convert a specified string representation of a date and time to its equivalent, and returns a value that indicates whether the conversion succeeded. + if the parameter is successfully converted; otherwise, . To be added. @@ -5575,8 +5574,7 @@ Me.ToUtcDateTime().ToFileTime() A bitwise combination of enumeration values that indicates the permitted format of . When the method returns, contains the value equivalent to the date and time of , if the conversion succeeded, or , if the conversion failed. The conversion fails if the parameter is or does not contain a valid string representation of a date and time. This parameter is passed uninitialized. Tries to convert a specified string representation of a date and time to its equivalent, and returns a value that indicates whether the conversion succeeded. - - if the parameter is successfully converted; otherwise, . + if the parameter is successfully converted; otherwise, . - To be added. - To be added. - To be added. - To be added. + A span containing the characters representing the number to convert. + When this method returns, contains the number that is equivalent to the numeric value contained in , if the conversion succeeded, or zero if the conversion failed. The conversion fails if the parameter is or , is not a number in a format compliant with , or represents a number less than or greater than . This parameter is passed uininitialized; any value originally supplied in is overwritten. + Converts the readonly char span representation of a number to its equivalent using the specified style and culture-specific format. A return value indicates whether the conversion succeeded or failed. + if was converted successfully; otherwise, . To be added. @@ -7360,12 +7360,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + A span containing the characters representing the number to convert. + A bitwise combination of enumeration values that indicates the permitted format of . A typical value to specify is . + An object that supplies culture-specific parsing information about . + When this method returns, contains the number that is equivalent to the numeric value contained in , if the conversion succeeded, or zero if the conversion failed. The conversion fails if the parameter is or , is not a number in a format compliant with , or represents a number less than or greater than . This parameter is passed uininitialized; any value originally supplied in is overwritten. + Converts the readonly char span representation of a number to its equivalent using the specified style and culture-specific format. A return value indicates whether the conversion succeeded or failed. + if was converted successfully; otherwise, . To be added. @@ -7415,10 +7415,9 @@ The string representation of the number to convert. A bitwise combination of enumeration values that indicates the permitted format of . A typical value to specify is . An object that supplies culture-specific parsing information about . - When this method returns, contains the number that is equivalent to the numeric value contained in , if the conversion succeeded, or zero if the conversion failed. The conversion fails if the parameter is or , is not a number in a format compliant with , or represents a number less than or greater than . This parameter is passed uininitialized; any value originally supplied in is overwritten. + When this method returns, contains the number that is equivalent to the numeric value contained in , if the conversion succeeded, or zero if the conversion failed. The conversion fails if the parameter is or , is not a number in a format compliant with , or represents a number less than or greater than . This parameter is passed uininitialized; any value originally supplied in is overwritten. Converts the string representation of a number to its equivalent using the specified style and culture-specific format. A return value indicates whether the conversion succeeded or failed. - - if was converted successfully; otherwise, . + if was converted successfully; otherwise, . - To be added. - To be added. - To be added. - To be added. + A span containing the characters representing the number to convert. + When this method returns, contains a double-precision floating-point number equivalent of the numeric value or symbol contained in , if the conversion succeeded, or zero if the conversion failed. The conversion fails if the parameter is or , is not in a format compliant with , represents a number less than or greater than , or if is not a valid combination of enumerated constants. This parameter is passed uninitialized; any value originally supplied in will be overwritten. + Converts the readonly char span representation of a number in a specified style and culture-specific format to its double-precision floating-point number equivalent. A return value indicates whether the conversion succeeded or failed. + if was converted successfully; otherwise, . To be added. @@ -3780,12 +3780,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + A span containing the characters representing the number to convert. + A bitwise combination of values that indicates the permitted format of . A typical value to specify is combined with . + An that supplies culture-specific formatting information about . + When this method returns, contains a double-precision floating-point number equivalent of the numeric value or symbol contained in , if the conversion succeeded, or zero if the conversion failed. The conversion fails if the parameter is or , is not in a format compliant with , represents a number less than or greater than , or if is not a valid combination of enumerated constants. This parameter is passed uninitialized; any value originally supplied in will be overwritten. + Converts the readonly char span representation of a number in a specified style and culture-specific format to its double-precision floating-point number equivalent. A return value indicates whether the conversion succeeded or failed. + if was converted successfully; otherwise, . To be added. @@ -3838,8 +3838,7 @@ An that supplies culture-specific formatting information about . When this method returns, contains a double-precision floating-point number equivalent of the numeric value or symbol contained in , if the conversion succeeded, or zero if the conversion failed. The conversion fails if the parameter is or , is not in a format compliant with , represents a number less than or greater than , or if is not a valid combination of enumerated constants. This parameter is passed uninitialized; any value originally supplied in will be overwritten. Converts the string representation of a number in a specified style and culture-specific format to its double-precision floating-point number equivalent. A return value indicates whether the conversion succeeded or failed. - - if was converted successfully; otherwise, . + if was converted successfully; otherwise, . - To be added. - To be added. - To be added. - To be added. - To be added. + The enum type to use for parsing. + The string representation of the name or numeric value of one or more enumerated constants. + When this method returns , an object containing an enumeration constant representing the parsed value. + Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. + if the conversion succeeded; otherwise. To be added. @@ -3183,12 +3183,12 @@ thisInstance And flag = flag - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The enum type to use for parsing. + The string representation of the name or numeric value of one or more enumerated constants. + to read in case insensitive mode; to read in case sensitive mode. + When this method returns , an object containing an enumeration constant representing the parsed value. + Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. + if the conversion succeeded; otherwise. To be added. diff --git a/xml/System/Guid.xml b/xml/System/Guid.xml index 91f4494a96b..664a7d0ee67 100644 --- a/xml/System/Guid.xml +++ b/xml/System/Guid.xml @@ -1713,8 +1713,8 @@ Because the `provider` parameter is ignored, you cannot use it to provide a cust - A span containing the characters representing GUID to convert. - The structure to contain the parsed value. If the method returns , contains a valid . If the method returns , equals . + A span containing the characters representing the GUID to convert. + A instance to contain the parsed value. If the method returns , contains a valid . If the method returns , equals . Converts the specified read-only span of characters containing the representation of a GUID to the equivalent structure. if the parse operation was successful; otherwise, . @@ -1756,11 +1756,10 @@ Because the `provider` parameter is ignored, you cannot use it to provide a cust - The GUID to convert. - The structure that will contain the parsed value. If the method returns , contains a valid . If the method returns , equals . + A string containing the GUID to convert. + A instance to contain the parsed value. If the method returns , contains a valid . If the method returns , equals . Converts the string representation of a GUID to the equivalent structure. - - if the parse operation was successful; otherwise, . + if the parse operation was successful; otherwise, . Date: Fri, 1 Nov 2019 20:12:20 -0700 Subject: [PATCH 2/2] rewordings --- xml/System/Boolean.xml | 2 +- xml/System/Byte.xml | 4 ++-- xml/System/DateTime.xml | 2 +- xml/System/DateTimeOffset.xml | 4 ++-- xml/System/Decimal.xml | 4 ++-- xml/System/Double.xml | 4 ++-- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/xml/System/Boolean.xml b/xml/System/Boolean.xml index 18c164a35aa..3ca62ec7c09 100644 --- a/xml/System/Boolean.xml +++ b/xml/System/Boolean.xml @@ -1824,7 +1824,7 @@ A span containing the characters representing the value to convert. When this method returns, if the conversion succeeded, contains if is equal to or if is equal to . If the conversion failed, contains . The conversion fails if is or is not equal to the value of either the or field. - Tries to convert the specified readonly char span representation of a logical value to its equivalent. + Tries to convert the specified span representation of a logical value to its equivalent. if was converted successfully; otherwise, . To be added. diff --git a/xml/System/Byte.xml b/xml/System/Byte.xml index 72726c59e2b..26b695e32df 100644 --- a/xml/System/Byte.xml +++ b/xml/System/Byte.xml @@ -2353,7 +2353,7 @@ A span containing the characters representing the number to convert. When this method returns, contains the value equivalent to the number contained in if the conversion succeeded, or zero if the conversion failed. This parameter is passed uninitialized; any value originally supplied in will be overwritten. - Tries to convert the readonly char span representation of a number to its equivalent, and returns a value that indicates whether the conversion succeeded. + Tries to convert the span representation of a number to its equivalent, and returns a value that indicates whether the conversion succeeded. if was converted successfully; otherwise, . To be added. @@ -2474,7 +2474,7 @@ A bitwise combination of enumeration values that indicates the style elements that can be present in . A typical value to specify is . An object that supplies culture-specific formatting information about . If is , the thread current culture is used. When this method returns, contains the 8-bit unsigned integer value equivalent to the number contained in if the conversion succeeded, or zero if the conversion failed. The conversion fails if the parameter is or , is not of the correct format, or represents a number less than or greater than . This parameter is passed uninitialized; any value originally supplied in will be overwritten. - Converts the readonly char span representation of a number in a specified style and culture-specific format to its equivalent. A return value indicates whether the conversion succeeded or failed. + Converts the span representation of a number in a specified style and culture-specific format to its equivalent. A return value indicates whether the conversion succeeded or failed. if was converted successfully; otherwise, . To be added. diff --git a/xml/System/DateTime.xml b/xml/System/DateTime.xml index ee13a7ac94e..32bd2ed524e 100644 --- a/xml/System/DateTime.xml +++ b/xml/System/DateTime.xml @@ -8225,7 +8225,7 @@ The value of the current object is formatted using the pa An object that supplies culture-specific formatting information about . A bitwise combination of enumeration values that defines how to interpret the parsed date in relation to the current time zone or the current date. A typical value to specify is . When this method returns, contains the value equivalent to the date and time contained in , if the conversion succeeded, or if the conversion failed. The conversion fails if the parameter is , is an empty string (""), or does not contain a valid string representation of a date and time. This parameter is passed uninitialized. - Converts the specified readonly char span representation of a date and time to its equivalent using the specified culture-specific format information and formatting style, and returns a value that indicates whether the conversion succeeded. + Converts the span representation of a date and time to its equivalent using the specified culture-specific format information and formatting style, and returns a value that indicates whether the conversion succeeded. if the parameter was converted successfully; otherwise, . To be added. diff --git a/xml/System/DateTimeOffset.xml b/xml/System/DateTimeOffset.xml index fef7e7d3a88..29503520500 100644 --- a/xml/System/DateTimeOffset.xml +++ b/xml/System/DateTimeOffset.xml @@ -5407,7 +5407,7 @@ Me.ToUtcDateTime().ToFileTime() A span containing the characters representing the date and time to convert. When the method returns, contains the equivalent to the date and time of , if the conversion succeeded, or , if the conversion failed. The conversion fails if the parameter is or does not contain a valid string representation of a date and time. This parameter is passed uninitialized. - Tries to convert a specified readonly char span representation of a date and time to its equivalent, and returns a value that indicates whether the conversion succeeded. + Tries to convert a specified span representation of a date and time to its equivalent, and returns a value that indicates whether the conversion succeeded. if the parameter is successfully converted; otherwise, . To be added. @@ -5521,7 +5521,7 @@ Me.ToUtcDateTime().ToFileTime() An object that provides culture-specific formatting information about . A bitwise combination of enumeration values that indicates the permitted format of . When the method returns, contains the value equivalent to the date and time of , if the conversion succeeded, or , if the conversion failed. The conversion fails if the parameter is or does not contain a valid string representation of a date and time. This parameter is passed uninitialized. - Tries to convert a specified string representation of a date and time to its equivalent, and returns a value that indicates whether the conversion succeeded. + Tries to convert a specified span representation of a date and time to its equivalent, and returns a value that indicates whether the conversion succeeded. if the parameter is successfully converted; otherwise, . To be added. diff --git a/xml/System/Decimal.xml b/xml/System/Decimal.xml index da979092f9e..564f1ca1d7a 100644 --- a/xml/System/Decimal.xml +++ b/xml/System/Decimal.xml @@ -7234,7 +7234,7 @@ A span containing the characters representing the number to convert. When this method returns, contains the number that is equivalent to the numeric value contained in , if the conversion succeeded, or zero if the conversion failed. The conversion fails if the parameter is or , is not a number in a format compliant with , or represents a number less than or greater than . This parameter is passed uininitialized; any value originally supplied in is overwritten. - Converts the readonly char span representation of a number to its equivalent using the specified style and culture-specific format. A return value indicates whether the conversion succeeded or failed. + Converts the span representation of a number to its equivalent using the specified style and culture-specific format. A return value indicates whether the conversion succeeded or failed. if was converted successfully; otherwise, . To be added. @@ -7364,7 +7364,7 @@ A bitwise combination of enumeration values that indicates the permitted format of . A typical value to specify is . An object that supplies culture-specific parsing information about . When this method returns, contains the number that is equivalent to the numeric value contained in , if the conversion succeeded, or zero if the conversion failed. The conversion fails if the parameter is or , is not a number in a format compliant with , or represents a number less than or greater than . This parameter is passed uininitialized; any value originally supplied in is overwritten. - Converts the readonly char span representation of a number to its equivalent using the specified style and culture-specific format. A return value indicates whether the conversion succeeded or failed. + Converts the span representation of a number to its equivalent using the specified style and culture-specific format. A return value indicates whether the conversion succeeded or failed. if was converted successfully; otherwise, . To be added. diff --git a/xml/System/Double.xml b/xml/System/Double.xml index 25a22a8e4e6..d174233cbdc 100644 --- a/xml/System/Double.xml +++ b/xml/System/Double.xml @@ -3647,7 +3647,7 @@ A span containing the characters representing the number to convert. When this method returns, contains a double-precision floating-point number equivalent of the numeric value or symbol contained in , if the conversion succeeded, or zero if the conversion failed. The conversion fails if the parameter is or , is not in a format compliant with , represents a number less than or greater than , or if is not a valid combination of enumerated constants. This parameter is passed uninitialized; any value originally supplied in will be overwritten. - Converts the readonly char span representation of a number in a specified style and culture-specific format to its double-precision floating-point number equivalent. A return value indicates whether the conversion succeeded or failed. + Converts the span representation of a number in a specified style and culture-specific format to its double-precision floating-point number equivalent. A return value indicates whether the conversion succeeded or failed. if was converted successfully; otherwise, . To be added. @@ -3784,7 +3784,7 @@ A bitwise combination of values that indicates the permitted format of . A typical value to specify is combined with . An that supplies culture-specific formatting information about . When this method returns, contains a double-precision floating-point number equivalent of the numeric value or symbol contained in , if the conversion succeeded, or zero if the conversion failed. The conversion fails if the parameter is or , is not in a format compliant with , represents a number less than or greater than , or if is not a valid combination of enumerated constants. This parameter is passed uninitialized; any value originally supplied in will be overwritten. - Converts the readonly char span representation of a number in a specified style and culture-specific format to its double-precision floating-point number equivalent. A return value indicates whether the conversion succeeded or failed. + Converts the span representation of a number in a specified style and culture-specific format to its double-precision floating-point number equivalent. A return value indicates whether the conversion succeeded or failed. if was converted successfully; otherwise, . To be added.