Fix minor issues in String.Substring documentation (dotnet#8597)

poke · web-flow · commit ca1a41cebc2b · 2022-10-31T14:35:07.000-07:00
diff --git a/xml/System/String.xml b/xml/System/String.xml
@@ -13153,12 +13153,12 @@ The following example defines a `StripStartTags` method that uses the <xref:Syst
           <format type="text/markdown"><![CDATA[
 
 ## Remarks
- You call the <xref:System.String.Substring(System.Int32)> method to extract a substring from a string that begins at a specified character position and ends at the end of the string. The starting character position is a zero-based; in other words, the first character in the string is at index 0, not index 1. To extract a substring that begins at a specified character position and ends before the end of the string, call the <xref:System.String.Substring(System.Int32%2CSystem.Int32)> method.
+ You call the <xref:System.String.Substring(System.Int32)> method to extract a substring from a string that begins at a specified character position and ends at the end of the string. The starting character position is zero-based; in other words, the first character in the string is at index 0, not index 1. To extract a substring that begins at a specified character position and ends before the end of the string, call the <xref:System.String.Substring(System.Int32%2CSystem.Int32)> method.
 
 > [!NOTE]
 > This method does not modify the value of the current instance. Instead, it returns a new string that begins at the `startIndex` position in the current string.
 
- To extract a substring that begins with a particular character or character sequence, call a method such as  <xref:System.String.IndexOf%2A> or <xref:System.String.IndexOf%2A> to get the value of `startIndex`. The second example illustrates this; it extracts a key value that begins one character position after the "=" character.
+ To extract a substring that begins with a particular character or character sequence, call a method such as <xref:System.String.IndexOf%2A> or <xref:System.String.IndexOf%2A> to get the value of `startIndex`. The second example illustrates this; it extracts a key value that begins one character position after the `=` character.
 
  If `startIndex` is equal to zero, the method returns the original string unchanged.
 ## Examples
@@ -13169,7 +13169,7 @@ The following example defines a `StripStartTags` method that uses the <xref:Syst
  :::code language="fsharp" source="~/snippets/fsharp/System/String/Substring/Substring10.fs" id="Snippet10":::
  :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/System.String.Substring/vb/Substring10.vb" id="Snippet10":::
 
- The following example uses the <xref:System.String.Substring%2A> method to separate key/value pairs that are delimited by an equals ("=") character.
+ The following example uses the <xref:System.String.Substring%2A> method to separate key/value pairs that are delimited by an equals (`=`) character.
 
  :::code language="csharp" source="~/snippets/csharp/System/String/Substring/Substring1.cs" interactive="try-dotnet-method" id="Snippet1":::
  :::code language="fsharp" source="~/snippets/fsharp/System/String/Substring/Substring1.fs" id="Snippet1":::
@@ -13250,32 +13250,32 @@ The following example defines a `StripStartTags` method that uses the <xref:Syst
           <format type="text/markdown"><![CDATA[
 
 ## Remarks
- You call the <xref:System.String.Substring(System.Int32%2CSystem.Int32)> method to extract a substring from a string that begins at a specified character position and ends before the end of the string. The starting character position is a zero-based; in other words, the first character in the string is at index 0, not index 1. To extract a substring that begins at a specified character position and continues to the end of the string, call the <xref:System.String.Substring(System.Int32)> method.
+ You call the <xref:System.String.Substring(System.Int32%2CSystem.Int32)> method to extract a substring from a string that begins at a specified character position and ends before the end of the string. The starting character position is zero-based; in other words, the first character in the string is at index 0, not index 1. To extract a substring that begins at a specified character position and continues to the end of the string, call the <xref:System.String.Substring(System.Int32)> method.
 
 > [!NOTE]
 > This method does not modify the value of the current instance. Instead, it returns a new string with `length` characters starting from the `startIndex` position in the current string.
 
- The `length` parameter represents the total number of characters to extract from the current string instance. This includes the starting character found at index  `startIndex`.  In other words, the <xref:System.String.Substring%2A> method attempts to extract characters from index `startIndex` to index `startIndex` + `length` - 1.
+ The `length` parameter represents the total number of characters to extract from the current string instance. This includes the starting character found at index  `startIndex`. In other words, the <xref:System.String.Substring%2A> method attempts to extract characters from index `startIndex` to index `startIndex` + `length` - 1.
 
- To extract a substring that begins with a particular character or character sequence, call a method such as  <xref:System.String.IndexOf%2A> or <xref:System.String.LastIndexOf%2A> to get the value of `startIndex`.
+ To extract a substring that begins with a particular character or character sequence, call a method such as <xref:System.String.IndexOf%2A> or <xref:System.String.LastIndexOf%2A> to get the value of `startIndex`.
 
- If the substring extends from `startIndex` to a specified character sequence, you can call a method such as  <xref:System.String.IndexOf%2A> or <xref:System.String.LastIndexOf%2A> to get the index of the ending character or character sequence.  You can then convert that value to an index position in the string as follows:
+ If the substring should extend from `startIndex` to a specified character sequence, you can call a method such as <xref:System.String.IndexOf%2A> or <xref:System.String.LastIndexOf%2A> to get the index of the ending character or character sequence. You can then convert that value to an index position in the string as follows:
 
-- If you've searched for a single character that is to mark the end of the substring, the `length` parameter equals  `endIndex` - `startIndex` + 1, where `endIndex` is the return value of the <xref:System.String.IndexOf%2A> or <xref:System.String.IndexOf%2A> method. The following example extracts a continuous block of "b" characters from a string.
+- If you've searched for a single character that is to mark the end of the substring, the `length` parameter equals  `endIndex` - `startIndex` + 1, where `endIndex` is the return value of the <xref:System.String.IndexOf%2A> or <xref:System.String.LastIndexOf%2A> method. The following example extracts a continuous block of "b" characters from a string.
 
      :::code language="csharp" source="~/snippets/csharp/System/String/Substring/Substring2.cs" interactive="try-dotnet-method" id="Snippet2":::
      :::code language="fsharp" source="~/snippets/fsharp/System/String/Substring/Substring2.fs" id="Snippet2":::
      :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/System.String.Substring/vb/Substring2.vb" id="Snippet2":::
 
-- If you've searched for multiple characters that are to mark the end of the substring, the `length` parameter equals  `endIndex` + `endMatchLength` - `startIndex`, where `endIndex` is the return value of the <xref:System.String.IndexOf%2A> or <xref:System.String.IndexOf%2A> method, and `endMatchLength` is the length of the character sequence that marks the end of the substring. The following example extracts a block of text that contains an XML `<definition>` element.
+- If you've searched for multiple characters that are to mark the end of the substring, the `length` parameter equals  `endIndex` + `endMatchLength` - `startIndex`, where `endIndex` is the return value of the <xref:System.String.IndexOf%2A> or <xref:System.String.LastIndexOf%2A> method, and `endMatchLength` is the length of the character sequence that marks the end of the substring. The following example extracts a block of text that contains an XML `<definition>` element.
 
      :::code language="csharp" source="~/snippets/csharp/System/String/Substring/Substring3.cs" interactive="try-dotnet-method" id="Snippet3":::
      :::code language="fsharp" source="~/snippets/fsharp/System/String/Substring/Substring3.fs" id="Snippet3":::
      :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/System.String.Substring/vb/Substring3.vb" id="Snippet3":::
 
-- If the character or character sequence is not included in the end of the substring, the `length` parameter equals `endIndex` - `startIndex`, where `endIndex` is the return value of the <xref:System.String.IndexOf%2A> or <xref:System.String.IndexOf%2A> method.
+- If the character or character sequence is not included in the end of the substring, the `length` parameter equals `endIndex` - `startIndex`, where `endIndex` is the return value of the <xref:System.String.IndexOf%2A> or <xref:System.String.LastIndexOf%2A> method.
 
- If `startIndex` is equal to zero and  equals the length of the current string, the method returns the original string unchanged.
+ If `startIndex` is equal to zero and `length` equals the length of the current string, the method returns the original string unchanged.
 
 ## Examples
  The following example illustrates a simple call to the <xref:System.String.Substring(System.Int32%2CSystem.Int32)> method that extracts two characters from a string starting at the sixth character position (that is, at index five).
@@ -13286,7 +13286,7 @@ The following example defines a `StripStartTags` method that uses the <xref:Syst
 
  The following example uses the <xref:System.String.Substring(System.Int32%2CSystem.Int32)> method in the following three cases to isolate substrings within a string. In two cases the substrings are used in comparisons, and in the third case an exception is thrown because invalid parameters are specified.
 
-- It extracts the single character and the third position in the string (at index 2) and compares it with a "c". This comparison returns `true`.
+- It extracts the single character at the third position in the string (at index 2) and compares it with a "c". This comparison returns `true`.
 
 - It extracts zero characters starting at the fourth position in the string (at index 3) and passes it to the <xref:System.String.IsNullOrEmpty%2A> method. This returns true because the call to the <xref:System.String.Substring%2A> method returns <xref:System.String.Empty?displayProperty=nameWithType>.
 
@@ -13296,7 +13296,7 @@ The following example defines a `StripStartTags` method that uses the <xref:Syst
  :::code language="fsharp" source="~/snippets/fsharp/System/String/Substring/source.fs" id="Snippet1":::
  :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_Classic/classic String.Substring1 Example/VB/source.vb" id="Snippet1":::
 
- The following example uses the <xref:System.String.Substring%2A> method to separate key/value pairs that are delimited by an equals ("=") character.
+ The following example uses the <xref:System.String.Substring%2A> method to separate key/value pairs that are delimited by an equals (`=`) character.
 
  :::code language="csharp" source="~/snippets/csharp/System/String/Substring/Substring1.cs" interactive="try-dotnet-method" id="Snippet1":::
  :::code language="fsharp" source="~/snippets/fsharp/System/String/Substring/Substring1.fs" id="Snippet1":::
