Skip to content

Commit cc11708

Browse files
authored
Fix up list indentation (#12758)
1 parent 7faab99 commit cc11708

69 files changed

Lines changed: 694 additions & 779 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

xml/System.CodeDom/CodeTypeReference.xml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -555,27 +555,27 @@ System.Collections.Generic.Dictionary`2[[System.String], [System.Collections.Gen
555555
556556
- The <xref:System.CodeDom.CodeTypeReference.BaseType> property for the parent <xref:System.CodeDom.CodeTypeReference> returns the following:
557557
558-
```
558+
```
559559
System.Collections.Generic.Dictionary`2
560-
```
560+
```
561561
562562
- The <xref:System.CodeDom.CodeTypeReference.BaseType> property for the first <xref:System.CodeDom.CodeTypeReference> object in the <xref:System.CodeDom.CodeTypeReference.TypeArguments*> collection returns the following:
563563
564-
```
564+
```
565565
System.String
566-
```
566+
```
567567
568568
- The <xref:System.CodeDom.CodeTypeReference.BaseType> property for the second <xref:System.CodeDom.CodeTypeReference> object in the <xref:System.CodeDom.CodeTypeReference.TypeArguments*> collection returns the following:
569569
570-
```
570+
```
571571
System.Collections.Generic.List`1
572-
```
572+
```
573573
574574
- The <xref:System.CodeDom.CodeTypeReference.TypeArguments> property in the <xref:System.CodeDom.CodeTypeReference> object for ``System.Collections.Generic.List`1`` returns the following:
575575
576-
```
576+
```
577577
System.Int32
578-
```
578+
```
579579
580580
The type argument count should be used when parsing the associated <xref:System.CodeDom.CodeTypeReference.TypeArguments*> values. The common practice is to remove the type argument count from the generated code, but the practice is compiler specific. It is important to note that the type argument count can be found within a nested type name, in which case it is followed by a plus sign ("+").
581581

xml/System.Collections.Concurrent/BlockingCollection`1.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -862,7 +862,7 @@ Do not modify the underlying collection directly. Use <xref:System.Collections.C
862862
For more information, see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged) and [Implementing a Dispose Method](/dotnet/standard/garbage-collection/implementing-dispose).
863863
864864
> [!NOTE]
865-
> Always call `Dispose` before you release your last reference to the <xref:System.Collections.Concurrent.BlockingCollection`1>. Otherwise, the resources it is using will not be freed until the garbage collector calls the <xref:System.Collections.Concurrent.BlockingCollection`1> object's `Finalize` method.
865+
> Always call `Dispose` before you release your last reference to the <xref:System.Collections.Concurrent.BlockingCollection`1>. Otherwise, the resources it is using will not be freed until the garbage collector calls the <xref:System.Collections.Concurrent.BlockingCollection`1> object's `Finalize` method.
866866
867867
]]></format>
868868
</remarks>

xml/System.ComponentModel.DataAnnotations/DisplayColumnAttribute.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,11 @@
6868
6969
- Applies the <xref:System.ComponentModel.DataAnnotations.DisplayColumnAttribute> attribute to the `Address` metadata partial class to specify the following:
7070
71-
- The City column from the Address table (the parent table) is displayed as the foreign-key column in the CustomerAddress child table.
71+
- The City column from the Address table (the parent table) is displayed as the foreign-key column in the CustomerAddress child table.
7272
73-
- The PostalCode column from the Address table (the parent table) is used for sorting the Address selection box in the CustomerAddress child table.
73+
- The PostalCode column from the Address table (the parent table) is used for sorting the Address selection box in the CustomerAddress child table.
7474
75-
- The sort order is set to ascending.
75+
- The sort order is set to ascending.
7676
7777
The example applies the <xref:System.ComponentModel.DataAnnotations.DisplayColumnAttribute> attribute to the `Customer` metadata partial class to specify that the LastName column in displayed as the foreign-key column for the CustomerAddress table.
7878

xml/System.ComponentModel.DataAnnotations/DisplayFormatAttribute.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,9 @@ The following example shows how to use the <xref:System.ComponentModel.DataAnnot
6060
6161
- In the associated metadata class, it applies the <xref:System.ComponentModel.DataAnnotations.DisplayFormatAttribute> attribute to specify the following results:
6262
63-
- Display the text "[Null]" when a data field is empty.
64-
- Display currency data in locale specific currency format.
65-
- Display date information in short format (mm/dd/yy). This format also applies in edit mode.
63+
- Display the text "[Null]" when a data field is empty.
64+
- Display currency data in locale specific currency format.
65+
- Display date information in short format (mm/dd/yy). This format also applies in edit mode.
6666
6767
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.ComponentModel.DataAnnotations.DisplayFormatAttribute/CS/product.cs" id="Snippet1":::
6868
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.ComponentModel.DataAnnotations.DisplayFormatAttribute/VB/product.vb" id="Snippet1":::

xml/System.ComponentModel.DataAnnotations/RangeAttribute.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,11 @@
5959
6060
- In the associated metadata class, it applies the <xref:System.ComponentModel.DataAnnotations.RangeAttribute> attribute to obtain the following results:
6161
62-
- Apply the attribute to a data field of type integer.
62+
- Apply the attribute to a data field of type integer.
6363
64-
- Apply the attribute to an integer data field and define a custom validation error message.
64+
- Apply the attribute to an integer data field and define a custom validation error message.
6565
66-
- Apply the attribute to a `DateTime` data field and define a custom validation error message.
66+
- Apply the attribute to a `DateTime` data field and define a custom validation error message.
6767
6868
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.ComponentModel.DataAnnotations.RangeAttribute/CS/Product.cs" id="Snippet1":::
6969
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.ComponentModel.DataAnnotations.RangeAttribute/VB/Product.vb" id="Snippet1":::

xml/System.ComponentModel.DataAnnotations/RequiredAttribute.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,9 @@
5858
5959
- In the associated metadata class, it applies the <xref:System.ComponentModel.DataAnnotations.RequiredAttribute> attribute, which specifies the following requirements:
6060
61-
- The Title data field cannot be empty. If validation fails, the code in the example throws a validation exception and displays an error message. The error message is specified at the time that the attribute is applied to the data field.
61+
- The Title data field cannot be empty. If validation fails, the code in the example throws a validation exception and displays an error message. The error message is specified at the time that the attribute is applied to the data field.
6262
63-
- The MiddleName data field cannot be empty. If validation fails, the code in the example throws a validation exception and displays an error message.
63+
- The MiddleName data field cannot be empty. If validation fails, the code in the example throws a validation exception and displays an error message.
6464
6565
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.ComponentModel.DataAnnotations.RequiredAttribute/CS/Customer.cs" id="Snippet1":::
6666
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.ComponentModel.DataAnnotations.RequiredAttribute/VB/Customer.vb" id="Snippet1":::

xml/System.ComponentModel/BindingList`1.xml

Lines changed: 12 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,6 @@
9999
100100
<xref:System.ComponentModel.BindingList`1> supports factory-created instances through the extensible <xref:System.ComponentModel.BindingList`1.AddNew*> method. (This same type of extensibility is also found in other classes, such as <xref:System.Windows.Forms.BindingSource>) In addition, since this class implements the <xref:System.ComponentModel.ICancelAddNew> interface, it enables transactional commits or rollbacks of the new item through the <xref:System.ComponentModel.BindingList`1.EndNew*> and <xref:System.ComponentModel.BindingList`1.CancelNew*> methods.
101101
102-
103-
104102
## Examples
105103
The following code example demonstrates binding to a <xref:System.ComponentModel.BindingList`1> component containing a business object. This is a complete example that contains a `Main` method.
106104
@@ -173,14 +171,12 @@
173171
## Remarks
174172
The following table shows initial property values for an instance of <xref:System.ComponentModel.BindingList`1> class.
175173
176-
|Property|Initial Value|
177-
|--------------|-------------------|
178-
|<xref:System.ComponentModel.BindingList`1.AllowEdit*>|`true`|
179-
|<xref:System.ComponentModel.BindingList`1.AllowNew*>|`true` if the list type has a parameterless constructor; otherwise, `false`.|
180-
|<xref:System.ComponentModel.BindingList`1.AllowRemove*>|`true`|
181-
|<xref:System.ComponentModel.BindingList`1.RaiseListChangedEvents*>|`true`|
182-
183-
174+
| Property | Initial Value |
175+
|--------------------------------------------------------------------|---------------|
176+
| <xref:System.ComponentModel.BindingList`1.AllowEdit*> | `true` |
177+
| <xref:System.ComponentModel.BindingList`1.AllowNew*> | `true` if the list type has a parameterless constructor; otherwise, `false`. |
178+
| <xref:System.ComponentModel.BindingList`1.AllowRemove*> | `true` |
179+
| <xref:System.ComponentModel.BindingList`1.RaiseListChangedEvents*> | `true` |
184180
185181
## Examples
186182
The following code example demonstrates how to construct a new <xref:System.ComponentModel.BindingList`1>. For the complete example, see the <xref:System.ComponentModel.BindingList`1> class overview topic.
@@ -302,8 +298,6 @@
302298
303299
For more information about supplying custom new item functionality, see the <xref:System.ComponentModel.BindingList`1.AddNew*> method. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/).
304300
305-
306-
307301
## Examples
308302
The following code example demonstrates how to handle the <xref:System.ComponentModel.BindingList`1.AddingNew> event. For the complete example, see the <xref:System.ComponentModel.BindingList`1> class overview topic.
309303
@@ -362,24 +356,21 @@
362356
## Remarks
363357
The <xref:System.ComponentModel.BindingList`1.AddNew*> method adds a new item to the collection represented by the <xref:System.Collections.ObjectModel.Collection`1.Items> property. To add a new item, the following logic is used:
364358
365-
1. The <xref:System.ComponentModel.BindingList`1.AddingNew> event is automatically raised.
359+
1. The <xref:System.ComponentModel.BindingList`1.AddingNew> event is automatically raised.
366360
367-
This event can be programmatically handled to construct a new custom item. This is accomplished in the event handler by setting the <xref:System.ComponentModel.AddingNewEventArgs.NewObject> property of the <xref:System.ComponentModel.AddingNewEventArgs> parameter to the new item.
361+
This event can be programmatically handled to construct a new custom item. This is accomplished in the event handler by setting the <xref:System.ComponentModel.AddingNewEventArgs.NewObject> property of the <xref:System.ComponentModel.AddingNewEventArgs> parameter to the new item.
368362
369-
Otherwise, the new item is automatically created through its public parameterless constructor.
363+
Otherwise, the new item is automatically created through its public parameterless constructor.
370364
371-
2. The position of the new item is tracked, but it is not added to the list until one of the following conditions are met:
365+
2. The position of the new item is tracked, but it is not added to the list until one of the following conditions are met:
372366
373-
- The item is explicitly committed by a call to <xref:System.ComponentModel.BindingList`1.EndNew*>.
374-
375-
- The item is implicitly committed by some other operation that changed the contents of the list, such as an insertion or removal of an item.
367+
- The item is explicitly committed by a call to <xref:System.ComponentModel.BindingList`1.EndNew*>.
368+
- The item is implicitly committed by some other operation that changed the contents of the list, such as an insertion or removal of an item.
376369
377370
In contrast, calling the <xref:System.ComponentModel.BindingList`1.CancelNew*> method before the item is committed will cause the new item to be discarded.
378371
379372
This method raises the <xref:System.ComponentModel.BindingList`1.ListChanged> event when the new item is committed.
380373
381-
382-
383374
## Examples
384375
The following code example demonstrates how to use the <xref:System.ComponentModel.BindingList`1.AddNew*> method. <xref:System.ComponentModel.BindingList`1>. For the complete example, see the <xref:System.ComponentModel.BindingList`1> class overview topic.
385376

xml/System.Configuration/ConfigurationCollectionAttribute.xml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,21 +51,21 @@
5151
5252
- The attributes that instruct .NET how to create instances of the custom configuration element properties. These types include:
5353
54-
- <xref:System.Configuration.ConfigurationCollectionAttribute>
54+
- <xref:System.Configuration.ConfigurationCollectionAttribute>
5555
56-
- <xref:System.Configuration.ConfigurationPropertyAttribute>
56+
- <xref:System.Configuration.ConfigurationPropertyAttribute>
5757
5858
- The attributes that instruct .NET how to validate the custom configuration element properties. These types include:
5959
60-
- <xref:System.Configuration.IntegerValidatorAttribute>
60+
- <xref:System.Configuration.IntegerValidatorAttribute>
6161
62-
- <xref:System.Configuration.LongValidatorAttribute>
62+
- <xref:System.Configuration.LongValidatorAttribute>
6363
64-
- <xref:System.Configuration.RegexStringValidatorAttribute>
64+
- <xref:System.Configuration.RegexStringValidatorAttribute>
6565
66-
- <xref:System.Configuration.StringValidatorAttribute>
66+
- <xref:System.Configuration.StringValidatorAttribute>
6767
68-
- <xref:System.Configuration.TimeSpanValidatorAttribute>
68+
- <xref:System.Configuration.TimeSpanValidatorAttribute>
6969
7070
## Examples
7171
The following example shows how to use the <xref:System.Configuration.ConfigurationCollectionAttribute>.

xml/System.Configuration/ConfigurationPropertyAttribute.xml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -49,23 +49,23 @@
4949
5050
The .NET configuration system provides attribute types that you can use during the creation of custom configuration elements. There are two kinds of attribute types:
5151
52-
1. The types instructing .NET how to instantiate the custom configuration-element properties. These types include:
52+
1. The types instructing .NET how to instantiate the custom configuration-element properties. These types include:
5353
54-
- <xref:System.Configuration.ConfigurationCollectionAttribute>
54+
- <xref:System.Configuration.ConfigurationCollectionAttribute>
5555
56-
- <xref:System.Configuration.ConfigurationPropertyAttribute>
56+
- <xref:System.Configuration.ConfigurationPropertyAttribute>
5757
58-
2. The types instructing .NET how to validate the custom configuration-element properties. These types include:
58+
2. The types instructing .NET how to validate the custom configuration-element properties. These types include:
5959
60-
- <xref:System.Configuration.IntegerValidatorAttribute>
60+
- <xref:System.Configuration.IntegerValidatorAttribute>
6161
62-
- <xref:System.Configuration.LongValidatorAttribute>
62+
- <xref:System.Configuration.LongValidatorAttribute>
6363
64-
- <xref:System.Configuration.RegexStringValidatorAttribute>
64+
- <xref:System.Configuration.RegexStringValidatorAttribute>
6565
66-
- <xref:System.Configuration.StringValidatorAttribute>
66+
- <xref:System.Configuration.StringValidatorAttribute>
6767
68-
- <xref:System.Configuration.TimeSpanValidatorAttribute>
68+
- <xref:System.Configuration.TimeSpanValidatorAttribute>
6969
7070
7171

xml/System.Configuration/ConfigurationSection.xml

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -75,21 +75,19 @@
7575

7676
- Reading. You use <see cref="M:System.Configuration.Configuration.GetSection(System.String)" /> or <see cref="M:System.Configuration.Configuration.GetSectionGroup(System.String)" /> to read configuration information. Note that the user or process that reads must have the following permissions:
7777

78-
- Read permission on the configuration file at the current configuration hierarchy level.
78+
- Read permission on the configuration file at the current configuration hierarchy level.
79+
- Read permissions on all the parent configuration files.
7980

80-
- Read permissions on all the parent configuration files.
81+
If your application needs read-only access to its own configuration, it is recommended you use the <see cref="Overload:System.Web.Configuration.WebConfigurationManager.GetSection" /> overloaded methods in the case of Web applications, or the <see cref="M:System.Configuration.ConfigurationManager.GetSection(System.String)" /> method in the case of client applications.
8182

82-
If your application needs read-only access to its own configuration, it is recommended you use the <see cref="Overload:System.Web.Configuration.WebConfigurationManager.GetSection" /> overloaded methods in the case of Web applications, or the <see cref="M:System.Configuration.ConfigurationManager.GetSection(System.String)" /> method in the case of client applications.
83-
84-
These methods provide access to the cached configuration values for the current application, which has better performance than the <see cref="T:System.Configuration.Configuration" /> class.
83+
These methods provide access to the cached configuration values for the current application, which has better performance than the <see cref="T:System.Configuration.Configuration" /> class.
8584

8685
Note: If you use a static <see langword="GetSection" /> method that takes a <paramref name="path" /> parameter, the <paramref name="path" /> parameter must refer to the application in which the code is running; otherwise, the parameter is ignored and configuration information for the currently-running application is returned.
8786

8887
- Writing. You use one of the <see cref="Overload:System.Configuration.Configuration.Save" /> methods to write configuration information. Note that the user or process that writes must have the following permissions:
8988

90-
- Write permission on the configuration file and directory at the current configuration hierarchy level.
91-
92-
- Read permissions on all the configuration files.</para>
89+
- Write permission on the configuration file and directory at the current configuration hierarchy level.
90+
- Read permissions on all the configuration files.</para>
9391
</block>
9492
<altmember cref="T:System.Configuration.Configuration" />
9593
<altmember cref="T:System.Configuration.SectionInformation" />
@@ -129,8 +127,6 @@ Note: If you use a static <see langword="GetSection" /> method that takes a <par
129127
## Remarks
130128
To use the <xref:System.Configuration.ConfigurationSection.%23ctor*> constructor, you need to define a custom section type first. For an example see the <xref:System.Configuration.ConfigurationSection> class overview.
131129
132-
133-
134130
## Examples
135131
The following example shows how to use the <xref:System.Configuration.ConfigurationSection.%23ctor*> constructor. This example assumes that you have created a custom section class named `CustomSection`. For an example of such a class, see the <xref:System.Configuration.ConfigurationSection> class overview.
136132
@@ -235,8 +231,6 @@ Note: If you use a static <see langword="GetSection" /> method that takes a <par
235231
236232
By default, <xref:System.Configuration.ConfigurationSection.GetRuntimeObject*> simply returns the object that represents the <xref:System.Configuration.ConfigurationSection> from which it is called.
237233
238-
239-
240234
## Examples
241235
The following example shows how to use the <xref:System.Configuration.ConfigurationSection.GetRuntimeObject*> method.
242236

0 commit comments

Comments
 (0)