Skip to content

Commit ce03429

Browse files
nschonniBillWagner
authored andcommitted
chore: cleanup includes/ (dotnet#15553)
Ran markdownlint --fix "includes/**/*.md" for MD009 and MD022
1 parent 148a69a commit ce03429

23 files changed

+33
-31
lines changed

includes/compiler-options.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11

2-
Every compiler option is available in two forms: **-option** and **/option**. The documentation only shows the -option form.
2+
Every compiler option is available in two forms: **-option** and **/option**. The documentation only shows the -option form.

includes/core-changes/aspnetcore/3.0/authz-iauthzpolicyprovider-new-method.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
In ASP.NET Core 3.0, a new `GetFallbackPolicyAsync` method was added to `IAuthorizationPolicyProvider`. This fallback policy is used by the authorization middleware when no policy is specified.
44

5-
For more information, see [aspnet/AspNetCore#9759](https://github.com/aspnet/AspNetCore/pull/9759).
5+
For more information, see [aspnet/AspNetCore#9759](https://github.com/aspnet/AspNetCore/pull/9759).
66

77
#### Version introduced
88

includes/core-changes/aspnetcore/3.0/caching-new-sqlclient-package.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The `Microsoft.Extensions.Caching.SqlServer` package used the `System.Data.SqlCl
2020

2121
#### Recommended action
2222

23-
Customers shouldn't need to worry about this breaking change unless they were using types returned by the `Microsoft.Extensions.Caching.SqlServer` package and casting them to `System.Data.SqlClient` types. For example, if someone was casting a `DbConnection` to the [old SqlConnection type](xref:System.Data.SqlClient.SqlConnection), they would need to change the cast to the new `Microsoft.Data.SqlClient.SqlConnection` type.
23+
Customers shouldn't need to worry about this breaking change unless they were using types returned by the `Microsoft.Extensions.Caching.SqlServer` package and casting them to `System.Data.SqlClient` types. For example, if someone was casting a `DbConnection` to the [old SqlConnection type](xref:System.Data.SqlClient.SqlConnection), they would need to change the cast to the new `Microsoft.Data.SqlClient.SqlConnection` type.
2424

2525
#### Category
2626

includes/core-changes/aspnetcore/3.0/http-defaulthttpcontext-extensibility-removed.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
As part of ASP.NET Core 3.0 performance improvements, the extensibility of `DefaultHttpContext` was removed. The class is now `sealed`. For more information, see [aspnet/AspNetCore#6504](https://github.com/aspnet/AspNetCore/pull/6504).
44

5-
If your unit tests use `Mock<DefaultHttpContext>`, use `Mock<HttpContext>` instead.
5+
If your unit tests use `Mock<DefaultHttpContext>`, use `Mock<HttpContext>` instead.
66

77
For discussion, see [aspnet/AspNetCore#6534](https://github.com/aspnet/AspNetCore/issues/6534).
88

@@ -24,7 +24,7 @@ The extensibility was provided initially to allow pooling of the `HttpContext`,
2424

2525
#### Recommended action
2626

27-
If you're using `Mock<DefaultHttpContext>` in your unit tests, begin using `Mock<HttpContext>` instead.
27+
If you're using `Mock<DefaultHttpContext>` in your unit tests, begin using `Mock<HttpContext>` instead.
2828

2929
#### Category
3030

includes/core-changes/aspnetcore/3.0/http-response-body-changes.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The motivation is to combine the response body APIs into a single new feature in
2424

2525
#### Recommended action
2626

27-
Use `IHttpResponseBodyFeature` where you previously were using `IHttpResponseFeature.Body`,
27+
Use `IHttpResponseBodyFeature` where you previously were using `IHttpResponseFeature.Body`,
2828
`IHttpSendFileFeature`, or `IHttpBufferingFeature`.
2929

3030
#### Category
@@ -36,7 +36,7 @@ ASP.NET Core
3636
- <xref:Microsoft.AspNetCore.Http.Features.IHttpBufferingFeature?displayProperty=nameWithType>
3737
- <xref:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.Body?displayProperty=fullName>
3838
- <xref:Microsoft.AspNetCore.Http.Features.IHttpSendFileFeature?displayProperty=nameWithType>
39-
39+
4040
<!--
4141
4242
#### Affected APIs

includes/core-changes/aspnetcore/3.0/http-synchronous-io-disabled.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ For discussion, see [aspnet/AspNetCore#7644](https://github.com/aspnet/AspNetCor
4545

4646
#### New behavior
4747

48-
These synchronous APIs are disallowed by default:
48+
These synchronous APIs are disallowed by default:
4949

5050
Expect errors similar to:
5151

includes/core-changes/aspnetcore/3.0/mvc-action-async-suffix-trimmed.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ This change doesn't affect names specified using the `[ActionName]` attribute. T
4040
```csharp
4141
services.AddMvc(options =>
4242
{
43-
options.SuppressAsyncSuffixInActionNames = false;
43+
options.SuppressAsyncSuffixInActionNames = false;
4444
});
4545
```
4646

@@ -58,7 +58,7 @@ If your app depends on MVC actions preserving the name's `Async` suffix, choose
5858
```csharp
5959
services.AddMvc(options =>
6060
{
61-
options.SuppressAsyncSuffixInActionNames = false;
61+
options.SuppressAsyncSuffixInActionNames = false;
6262
});
6363
```
6464

includes/core-changes/aspnetcore/3.0/mvc-precompilation-tool-deprecated.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
In ASP.NET Core 1.1, the `Microsoft.AspNetCore.Mvc.Razor.ViewCompilation` (MVC precompilation tool) package was introduced to add support for publish-time compilation of Razor files (*.cshtml* files). In ASP.NET Core 2.1, the [Razor SDK](/aspnet/core/razor-pages/sdk?view=aspnetcore-2.1) was introduced to expand upon features of the precompilation tool. The Razor SDK added support for build- and publish-time compilation of Razor files. The SDK verifies the correctness of *.cshtml* files at build time while improving on app startup time. The Razor SDK is on by default, and no gesture is required to start using it.
44

5-
In ASP.NET Core 3.0, the ASP.NET Core 1.1-era MVC precompilation tool was removed. Earlier package versions will continue receiving important bug and security fixes in the patch release.
5+
In ASP.NET Core 3.0, the ASP.NET Core 1.1-era MVC precompilation tool was removed. Earlier package versions will continue receiving important bug and security fixes in the patch release.
66

77
#### Version introduced
88

includes/core-changes/aspnetcore/3.0/session-obsolete-apis-removed.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### Session state: Obsolete APIs removed
1+
### Session state: Obsolete APIs removed
22

33
Obsolete APIs for configuring session cookies were removed. For more information, see [aspnet/Announcements#257](https://github.com/aspnet/Announcements/issues/257).
44

includes/core-changes/aspnetcore/3.0/sharedfx-app-shared-framework-assemblies.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### Shared framework: Assemblies removed from Microsoft.AspNetCore.App
22

3-
Starting in ASP.NET Core 3.0, the ASP.NET Core shared framework (`Microsoft.AspNetCore.App`) only contains first-party assemblies that are fully developed, supported, and serviceable by Microsoft.
3+
Starting in ASP.NET Core 3.0, the ASP.NET Core shared framework (`Microsoft.AspNetCore.App`) only contains first-party assemblies that are fully developed, supported, and serviceable by Microsoft.
44

55
#### Change description
66

includes/core-changes/aspnetcore/3.0/signalr-successhandshakedata-replaced.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### SignalR: HandshakeProtocol.SuccessHandshakeData replaced
22

3-
The [HandshakeProtocol.SuccessHandshakeData](https://github.com/aspnet/AspNetCore/blob/c5b2bc0df2a0027832bf7d01dfb19ca39cd08ae6/src/SignalR/common/SignalR.Common/src/Protocol/HandshakeProtocol.cs#L27) field was removed and replaced with a helper method that generates a successful handshake response given a specific `IHubProtocol`.
3+
The [HandshakeProtocol.SuccessHandshakeData](https://github.com/aspnet/AspNetCore/blob/c5b2bc0df2a0027832bf7d01dfb19ca39cd08ae6/src/SignalR/common/SignalR.Common/src/Protocol/HandshakeProtocol.cs#L27) field was removed and replaced with a helper method that generates a successful handshake response given a specific `IHubProtocol`.
44

55
#### Version introduced
66

@@ -12,7 +12,7 @@ The [HandshakeProtocol.SuccessHandshakeData](https://github.com/aspnet/AspNetCor
1212

1313
#### New behavior
1414

15-
`HandshakeProtocol.SuccessHandshakeData` has been replaced by a `static` `GetSuccessfulHandshake(IHubProtocol protocol)` method that returns a `ReadOnlyMemory<byte>` based on the specified protocol.
15+
`HandshakeProtocol.SuccessHandshakeData` has been replaced by a `static` `GetSuccessfulHandshake(IHubProtocol protocol)` method that returns a `ReadOnlyMemory<byte>` based on the specified protocol.
1616

1717
#### Reason for change
1818

includes/core-changes/corefx/floating-point-parsing-does-not-overflow.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ In .NET Core 2.2 and earlier versions, the <xref:System.Double.Parse%2A?displayP
88

99
Starting with .NET Core 3.0, the <xref:System.Double.Parse%2A?displayProperty=nameWithType>, <xref:System.Double.TryParse%2A?displayProperty=nameWithType>, <xref:System.Single.Parse%2A?displayProperty=nameWithType>, and <xref:System.Single.TryParse%2A?displayProperty=nameWithType> methods no longer fail when parsing out-of-range numeric strings. Instead, the <xref:System.Double> parsing methods return <xref:System.Double.PositiveInfinity?displayProperty=nameWithType> for values that exceed <xref:System.Double.MaxValue?displayProperty=nameWithType>, and they return <xref:System.Double.NegativeInfinity?displayProperty=nameWithType> for values that are less than <xref:System.Double.MinValue?displayProperty=nameWithType>. Similarly, the <xref:System.Single> parsing methods return <xref:System.Single.PositiveInfinity?displayProperty=nameWithType> for values that exceed <xref:System.Single.MaxValue?displayProperty=nameWithType>, and they return <xref:System.Single.NegativeInfinity?displayProperty=nameWithType> for values that are less than <xref:System.Single.MinValue?displayProperty=nameWithType>.
1010

11-
This change was made for improved IEEE 754:2008 compliance.
11+
This change was made for improved IEEE 754:2008 compliance.
1212

1313
#### Version introduced
1414

includes/core-changes/corefx/jsonfactoryconverter-createconverter.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ To facilitate the composition of <xref:System.Text.Json.Serialization.JsonConver
44

55
#### Change description
66

7-
The signature of the `CreateConverter` method in .NET Core prior to version 3.0 Preview 8 was:
7+
The signature of the `CreateConverter` method in .NET Core prior to version 3.0 Preview 8 was:
88

99
```csharp
1010
namespace System.Text.Json.Serialization

includes/core-changes/globalization/c-locale-maps-to-invariant-locale.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
### "C" locale maps to the invariant locale
22

3-
.NET Core 2.2 and earlier versions depend on the default ICU behavior, which maps the "C" locale to the en_US_POSIX locale. The en_US_POSIX locale has an undesirable collation behavior, because it doesn't support case-insensitive string comparisons. Because some Linux distributions set the "C" locale as the default locale, users were experiencing unexpected behavior.
3+
.NET Core 2.2 and earlier versions depend on the default ICU behavior, which maps the "C" locale to the en_US_POSIX locale. The en_US_POSIX locale has an undesirable collation behavior, because it doesn't support case-insensitive string comparisons. Because some Linux distributions set the "C" locale as the default locale, users were experiencing unexpected behavior.
44

55
#### Change description
66

77
Starting with .NET Core 3.0, the "C" locale mapping has changed to use the Invariant locale instead of en_US_POSIX. The "C" locale to Invariant mapping is also applied to Windows for consistency.
88

9-
Mapping "C" to en_US_POSIX culture caused customer confusion, because en_US_POSIX doesn't support case insensitive sorting/searching string operations. Because the "C" locale is used as a default locale in some of the Linux distros, customers experienced this undesired behavior on these operating systems.
9+
Mapping "C" to en_US_POSIX culture caused customer confusion, because en_US_POSIX doesn't support case insensitive sorting/searching string operations. Because the "C" locale is used as a default locale in some of the Linux distros, customers experienced this undesired behavior on these operating systems.
1010

1111
#### Version introduced
1212

@@ -18,7 +18,7 @@ Nothing specific more than the awareness of this change. This change affects onl
1818

1919
### Category
2020

21-
Globalization
21+
Globalization
2222

2323
### Affected APIs
2424

includes/core-changes/networking/httprequestmessage-version-change.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### Default value of HttpRequestMessage.Version changed to 1.1
1+
### Default value of HttpRequestMessage.Version changed to 1.1
22

33
The default value of the <xref:System.Net.Http.HttpRequestMessage.Version?displayProperty=fullName> property has changed from 2.0 to 1.1.
44

@@ -8,10 +8,10 @@ The default value of the <xref:System.Net.Http.HttpRequestMessage.Version?displa
88

99
#### Change description
1010

11-
In .NET Core 1.0 through 2.0, the default value of the <xref:System.Net.Http.HttpRequestMessage.Version?displayProperty=fullName> property is 1.1. Starting with .NET Core 2.1, it was changed to 2.1.
11+
In .NET Core 1.0 through 2.0, the default value of the <xref:System.Net.Http.HttpRequestMessage.Version?displayProperty=fullName> property is 1.1. Starting with .NET Core 2.1, it was changed to 2.1.
1212

1313
Starting with .NET Core 3.0, the default version number returned by the <xref:System.Net.Http.HttpRequestMessage.Version?displayProperty=fullName> property is once again 1.1.
14-
14+
1515
#### Recommended action
1616

1717
Update your code if it depends on the <xref:System.Net.Http.HttpRequestMessage.Version?displayProperty=fullName> property returning a default value of 2.0.

includes/core-changes/versionselector.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
> - [(3.0 Preview 7| 3.0 Preview 8)](~/docs/core/compatibility/3.0.7-3.0.8.md)
77
> - [(3.0 Preview 8| 3.0 Preview 9)](~/docs/core/compatibility/3.0.8-3.0.9.md)
88
> - [(3.0 Preview 9| 3.0 RC1)](~/docs/core/compatibility/3.0.9-3.0rc1.md)
9-
>
9+
1010
<!--
1111
1212
> - [(2.2 | 3.0 Preview 7)](~/docs/core/compatibility/2.2-3.0.7.md)

includes/core-changes/visualbasic/microsoft.visualbasic.applicationservices-unavailable.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The types in the <xref:Microsoft.VisualBasic.ApplicationServices?displayProperty
1111
The types in the <xref:Microsoft.VisualBasic.ApplicationServices?displayProperty=fullName> namespace were available in some .NET Core 3.0 Preview releases. They are no longer available starting with .NET Core 3.0 Preview 9.
1212

1313
The types were removed to avoid unnecessary assembly dependencies or breaking changes in subsequent releases.
14-
14+
1515
#### Recommended action
1616

1717
If your code depends on the use of <xref:Microsoft.VisualBasic.ApplicationServices> types and their members, you may be able to use a corresponding type or member in the .NET class library. For example, some <xref:System.Environment?displayProperty=nameWithType> and <xref:System.Security.Principal.WindowsIdentity?displayProperty=nameWithType> members provide equivalent functionality to the properties of the <xref:Microsoft.VisualBasic.ApplicationServices.User?displayProperty=nameWithType> class.

includes/core-changes/visualbasic/microsoft.visualbasic.devices-unavailable.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The types in the <xref:Microsoft.VisualBasic.Devices?displayProperty=fullName> n
1111
The types in the <xref:Microsoft.VisualBasic.Devices?displayProperty=fullName> namespace were available in some .NET Core 3.0 Preview releases,. They are no longer available starting with .NET Core 3.0 Preview 9.
1212

1313
The types were removed to avoid unnecessary assembly dependencies or breaking changes in subsequent releases.
14-
14+
1515
#### Recommended action
1616

1717
If your code depends on the use of <xref:Microsoft.VisualBasic.Devices> types and their members, you may be able to use a corresponding type or member in the .NET class library. For example, equivalent functionality to the <xref:Microsoft.VisualBasic.Devices.Clock?displayProperty=nameWithType> class is provided by the <xref:System.DateTime?displayProperty=nameWithType> and <xref:System.Environment?displayProperty=nameWithType> types, and equivalent functionality to the <xref:Microsoft.VisualBasic.Devices.Ports?displayProperty=nameWithType> class is provided by types in the <xref:System.IO.Ports?displayProperty=nameWithType> namespace.

includes/core-changes/visualbasic/microsoft.visualbasic.myservices-unavailable.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ The types in the <xref:Microsoft.VisualBasic.MyServices?displayProperty=fullName
1111
The types in the <xref:Microsoft.VisualBasic.MyServices?displayProperty=fullName> namespace were available in some .NET Core 3.0 Preview releases. They are no longer available starting with .NET Core 3.0 Preview 9.
1212

1313
The types were removed to avoid unnecessary assembly dependencies or breaking changes in subsequent releases.
14-
14+
1515
#### Recommended action
1616

1717
If your code depends on the use of **Microsoft.VisualBasic.MyServices** types and their members, there are corresponding types and members in the .NET class library. The following is a mapping of **Microsoft.VisualBasic.MyServices** types to their equivalent .NET class library types:
1818

1919
|Microsoft.VisualBasic.MyServices type|.NET class library type|
2020
|--|--|
21-
|<xref:Microsoft.VisualBasic.MyServices.ClipboardProxy>|<xref:System.Windows.Clipboard?displayProperty=nameWithType> for WPF applications, <xref:System.Windows.Forms.Clipboard?displayProperty=nameWithType> for Windows Forms applications|
21+
|<xref:Microsoft.VisualBasic.MyServices.ClipboardProxy>|<xref:System.Windows.Clipboard?displayProperty=nameWithType> for WPF applications, <xref:System.Windows.Forms.Clipboard?displayProperty=nameWithType> for Windows Forms applications|
2222
|<xref:Microsoft.VisualBasic.MyServices.FileSystemProxy>|Types in the <xref:System.IO> namespace|
2323
|<xref:Microsoft.VisualBasic.MyServices.RegistryProxy>|Registry-related types in the <xref:Microsoft.Win32> namespace|
2424
|<xref:Microsoft.VisualBasic.MyServices.SpecialDirectoriesProxy>|<xref:System.Environment.GetFolderPath%2A?displayProperty=nameWithType>|

includes/core-changes/windowsforms/deprecate-enablevisualstylevalidation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The `Switch.System.Windows.Forms.EnableVisualStyleValidation` compatibility swit
44

55
#### Change description
66

7-
In .NET Framework, the `Switch.System.Windows.Forms.EnableVisualStyleValidation` compatibility switch allowed an application to opt out of validation of visual styles supplied in a numeric form.
7+
In .NET Framework, the `Switch.System.Windows.Forms.EnableVisualStyleValidation` compatibility switch allowed an application to opt out of validation of visual styles supplied in a numeric form.
88

99
In .NET Core, the `Switch.System.Windows.Forms.EnableVisualStyleValidation` switch is not supported.
1010

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

22
> [!NOTE]
3-
> Some of the C# examples in this article run in the [Try.NET](https://dotnet.microsoft.com/platform/try-dotnet) inline code runner and playground. Select the **Run** button to run an example in an interactive window. Once you execute the code, you can modify it and run the modified code by selecting **Run** again. The modified code either runs in the interactive window or, if compilation fails, the interactive window displays all C# compiler error messages.
4-
>
3+
> Some of the C# examples in this article run in the [Try.NET](https://dotnet.microsoft.com/platform/try-dotnet) inline code runner and playground. Select the **Run** button to run an example in an interactive window. Once you execute the code, you can modify it and run the modified code by selecting **Run** again. The modified code either runs in the interactive window or, if compilation fails, the interactive window displays all C# compiler error messages.
4+
>
55
> The [local time zone](xref:System.TimeZoneInfo.Local) of the [Try.NET](https://dotnet.microsoft.com/platform/try-dotnet) inline code runner and playground is Coordinated Universal Time, or UTC. This may affect the behavior and the output of examples that illustrate the <xref:System.DateTime>, <xref:System.DateTimeOffset>, and <xref:System.TimeZoneInfo> types and their members.

includes/migration-guide/retargeting/introduction.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
## Introduction
2+
23
Retargeting changes affect apps that are recompiled to target a different .NET Framework. They include:
34

45
* Changes in the design-time environment. For example, build tools may emit warnings when previously they did not.

includes/migration-guide/runtime/introduction.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
## Introduction
2+
23
Runtime changes affect all apps that are running under a .NET Framework it was not compiled against and that use a particular feature.
34

45
In the topics that describe runtime changes, we have classified individual items by their expected impact, as follows:

0 commit comments

Comments
 (0)