Skip to content

Commit e72182e

Browse files
authored
Fix MD059 violations (#46315)
1 parent 0ca423a commit e72182e

File tree

38 files changed

+102
-105
lines changed

38 files changed

+102
-105
lines changed

.markdownlint-cli2.jsonc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,7 @@
5959
"MD050": {
6060
"style": "asterisk"
6161
},
62-
"MD051": false,
63-
"MD059": false
62+
"MD051": false
6463
},
6564
"ignores": [
6665
".github/",

docs/architecture/blazor-for-web-forms-developers/security-authentication-authorization.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -255,15 +255,15 @@ It's also worth considering putting any additional columns on separate tables. S
255255

256256
### Migrating data from universal providers to ASP.NET Core Identity
257257

258-
Once you have the destination table schema in place, the next step is to migrate your user and role records to the new schema. A complete list of the schema differences, including which columns map to which new columns, can be found [here](/aspnet/core/migration/proper-to-2x/membership-to-core-identity).
258+
Once you have the destination table schema in place, the next step is to migrate your user and role records to the new schema. For a complete list of the schema differences, including which columns map to which new columns, see [Migrate from ASP.NET Membership authentication to ASP.NET Core 2.0 Identity](/aspnet/core/migration/proper-to-2x/membership-to-core-identity).
259259

260-
To migrate your users from membership to the new identity tables, you should [follow the steps described in the documentation](/aspnet/core/migration/proper-to-2x/membership-to-core-identity). After following these steps and the script provided, your users will need to change their password the next time they log in.
260+
To migrate your users from membership to the new identity tables, follow the steps described in [Migrate from ASP.NET Membership authentication to ASP.NET Core 2.0 Identity](/aspnet/core/migration/proper-to-2x/membership-to-core-identity). After following these steps and the script provided, your users will need to change their password the next time they log in.
261261

262-
It is possible to migrate user passwords but the process is much more involved. Requiring users to update their passwords as part of the migration process, and encouraging them to use new, unique passwords, is likely to enhance the overall security of the application.
262+
It's possible to migrate user passwords, but the process is much more involved. Requiring users to update their passwords as part of the migration process, and encouraging them to use new, unique passwords, is likely to enhance the overall security of the application.
263263

264264
### Migrating security settings from web.config to app startup
265265

266-
As noted above, ASP.NET membership and role providers are configured in the application's `web.config` file. Since ASP.NET Core apps are not tied to IIS and use a separate system for configuration, these settings must be configured elsewhere. For the most part, ASP.NET Core Identity is configured in the *Program.cs* file. Open the web project that was created earlier (to generate the identity table schema) and review its *Program.cs* (or *Startup.cs*) file.
266+
As noted previously, ASP.NET membership and role providers are configured in the application's `web.config` file. Since ASP.NET Core apps are not tied to IIS and use a separate system for configuration, these settings must be configured elsewhere. For the most part, ASP.NET Core Identity is configured in the *Program.cs* file. Open the web project that was created earlier (to generate the identity table schema) and review its *Program.cs* (or *Startup.cs*) file.
267267

268268
This code adds support for EF Core and Identity:
269269

docs/architecture/cloud-native/deploy-eshoponcontainers-azure.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,8 @@ You'll find the eShopOnContainers helm charts in the /k8s/helm folder. Figure 2-
5757
5858
Each individual component is installed using a `helm install` command. eShop includes a "deploy all" script that loops through and installs the components using their respective helm charts. The result is a repeatable process, versioned with the application in source control, that anyone on the team can deploy to an AKS cluster with a one-line script command.
5959

60-
> Note that version 3 of Helm officially removes the need for the Tiller server component. More information on this enhancement can be found [here](https://medium.com/better-programming/why-is-tiller-missing-in-helm-3-2347c446714).
60+
> [!NOTE]
61+
> Version 3 of Helm officially removes the need for the Tiller server component. For more information on this enhancement, see [Why is Tiller Missing in Helm 3?](https://medium.com/better-programming/why-is-tiller-missing-in-helm-3-2347c446714).
6162

6263
## Azure Functions and Logic Apps (Serverless)
6364

docs/architecture/microservices/microservice-ddd-cqrs-patterns/infrastructure-persistence-layer-implementation-entity-framework-core.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -408,7 +408,7 @@ public abstract class BaseSpecification<T> : ISpecification<T>
408408
}
409409

410410
// string-based includes allow for including children of children
411-
// e.g. Basket.Items.Product
411+
// for example, Basket.Items.Product
412412
protected virtual void AddInclude(string includeString)
413413
{
414414
IncludeStrings.Add(includeString);

docs/core/extensions/log-sampling.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Log sampling rules evaluation is performed on each log record, however, there ar
104104
- Select rules with `EventId` not defined or defined and equal to the log event ID.
105105
- Select rules with longest matching category prefix. If no match is found, select all rules that don't specify a category.
106106
- If multiple rules are selected, take the **last** one.
107-
- If no rules are selected, sampling is not applied, e.g. the log record is emitted as usual.
107+
- If no rules are selected, sampling is not applied, for example, the log record is emitted as usual.
108108

109109
### Inline code configuration
110110

@@ -143,18 +143,18 @@ For each log record that isn't filtered out, the <xref:Microsoft.Extensions.Logg
143143

144144
Log sampling is designed to reduce storage costs, with a trade-off of slightly increased CPU usage. If your application generates a high volume of logs that are expensive to store, sampling can help reduce that volume. When configured appropriately, sampling can lower storage costs without losing information that's critical for diagnosing incidents.
145145

146-
For the built-in sampling, see the benchmarks [here](https://github.com/dotnet/extensions/blob/main/bench/Libraries/Microsoft.Extensions.Telemetry.PerformanceTests/README.md).
146+
For the built-in sampling, see [Benchmarks](https://github.com/dotnet/extensions/blob/main/bench/Libraries/Microsoft.Extensions.Telemetry.PerformanceTests/README.md).
147147

148148
## Log level guidance on when to use sampling
149149

150-
| Log level | Recommendation |
151-
|--|--|
152-
| <xref:Microsoft.Extensions.Logging.LogLevel.Trace> | Don't apply sampling, because normally you disable these logs in production |
153-
| <xref:Microsoft.Extensions.Logging.LogLevel.Debug> | Don't apply sampling, because normally you disable these logs in production |
154-
| <xref:Microsoft.Extensions.Logging.LogLevel.Information> | Do apply sampling |
155-
| <xref:Microsoft.Extensions.Logging.LogLevel.Warning> | Consider applying sampling |
156-
| <xref:Microsoft.Extensions.Logging.LogLevel.Error> | Don't apply sampling |
157-
| <xref:Microsoft.Extensions.Logging.LogLevel.Critical> | Don't apply sampling |
150+
| Log level | Recommendation |
151+
|----------------------------------------------------------|----------------------------|
152+
| <xref:Microsoft.Extensions.Logging.LogLevel.Trace> | Don't apply sampling, because normally you disable these logs in production |
153+
| <xref:Microsoft.Extensions.Logging.LogLevel.Debug> | Don't apply sampling, because normally you disable these logs in production |
154+
| <xref:Microsoft.Extensions.Logging.LogLevel.Information> | Do apply sampling |
155+
| <xref:Microsoft.Extensions.Logging.LogLevel.Warning> | Consider applying sampling |
156+
| <xref:Microsoft.Extensions.Logging.LogLevel.Error> | Don't apply sampling |
157+
| <xref:Microsoft.Extensions.Logging.LogLevel.Critical> | Don't apply sampling |
158158

159159
## Best practices
160160

docs/core/testing/microsoft-testing-platform-architecture-extensions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -494,11 +494,11 @@ internal sealed class TestingFramework
494494

495495
#### Well-known properties
496496

497-
As detailed in the [requests section](#handling-requests), the testing platform identifies specific properties added to the `TestNodeUpdateMessage` to determine the status of a `TestNode` (e.g., successful, failed, skipped, etc.). This allows the runtime to accurately display a list of failed tests with their corresponding information in the console, and to set the appropriate exit code for the test process.
497+
As detailed in the [requests section](#handling-requests), the testing platform identifies specific properties added to the `TestNodeUpdateMessage` to determine the status of a `TestNode` (for example, successful, failed, skipped, etc.). This allows the runtime to accurately display a list of failed tests with their corresponding information in the console, and to set the appropriate exit code for the test process.
498498

499499
In this segment, we'll elucidate the various well-known `IProperty` options and their respective implications.
500500

501-
If you're looking for a comprehensive list of well-known properties, you can find it [here](https://github.com/microsoft/testfx/blob/main/src/Platform/Microsoft.Testing.Platform/Messages/TestNodeProperties.cs). If you notice that a property description is missing, please don't hesitate to file an issue.
501+
For a comprehensive list of well-known properties, see [TestNodeProperties.cs](https://github.com/microsoft/testfx/blob/main/src/Platform/Microsoft.Testing.Platform/Messages/TestNodeProperties.cs). If you notice that a property description is missing, please file an issue.
502502

503503
These properties can be divided in the following categories:
504504

docs/core/testing/unit-testing-code-coverage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ Below is the example *coverage.cobertura.xml* file.
271271
> ```
272272
>
273273
> The resulting *coverage.cobertura.xml* file is output.
274-
> You can follow MSBuild integration guide [here](https://github.com/coverlet-coverage/coverlet/blob/master/Documentation/MSBuildIntegration.md)
274+
> For more information, see [Coverlet integration with MSBuild](https://github.com/coverlet-coverage/coverlet/blob/master/Documentation/MSBuildIntegration.md)
275275
276276
## Generate reports
277277

docs/core/testing/unit-testing-mstest-getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ MSTest functionality is split into multiple NuGet packages:
1616

1717
We recommend that you don't install these packages directly into your test projects. Instead, you should use either:
1818

19-
- [MSTest.Sdk](https://www.nuget.org/packages/MSTest.Sdk): A [MSBuild project SDK](/visualstudio/msbuild/how-to-use-project-sdk) that includes all the recommended packages and greatly simplifies all the boilerplate configuration. Although this is shipped as a NuGet package, it's not intended to be installed as a regular package dependency, instead you should modify the `Sdk` part of your project (e.g. `<Project Sdk="MSTest.Sdk">` or `<Project Sdk="MSTest.Sdk/X.Y.Z">` where `X.Y.Z` is MSTest version). For more information, please refer to [MSTest SDK overview](./unit-testing-mstest-sdk.md).
19+
- [MSTest.Sdk](https://www.nuget.org/packages/MSTest.Sdk): A [MSBuild project SDK](/visualstudio/msbuild/how-to-use-project-sdk) that includes all the recommended packages and greatly simplifies all the boilerplate configuration. Although this is shipped as a NuGet package, it's not intended to be installed as a regular package dependency, instead you should modify the `Sdk` part of your project (for example, `<Project Sdk="MSTest.Sdk">` or `<Project Sdk="MSTest.Sdk/X.Y.Z">` where `X.Y.Z` is MSTest version). For more information, please refer to [MSTest SDK overview](./unit-testing-mstest-sdk.md).
2020

2121
- the [MSTest](https://www.nuget.org/packages/MSTest) NuGet package, which includes all recommended packages: `MSTest.TestFramework`, `MSTest.TestAdapter`, `MSTest.Analyzers` and `Microsoft.NET.Test.Sdk`.
2222

docs/core/testing/unit-testing-mstest-migration-from-v1-to-v3.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Even if you’re satisfied with your current MSTest setup, upgrading to MSTest v
3030

3131
- **Increased Code Reliability with New Analyzers**: MSTest v3 built-in code analyzers enforce best practices, helping to catch issues early and promoting cleaner, more maintainable test code:
3232
- **Proactive Issue Detection**: The analyzers provide real-time feedback, suggesting improvements and flagging potential issues as you write your tests.
33-
33+
3434
- **Stronger Type-Safe Assertions**: Replacing ambiguous overloads, MSTest v3 enforces type-safe assertions, reducing the risk of incorrect test behavior and making tests more reliable.
3535
- **Cleaner Code, Less Maintenance**: By aligning your tests with MSTest standards and best practices, MSTest v3 helps you maintain a cleaner, more manageable codebase, reducing technical debt over time.
3636

@@ -146,7 +146,7 @@ In cases where types don’t match exactly, MSTest v3 will now raise an error ra
146146
147147
In MSTest v3, the handling of `Timeout` settings has been standardized to ensure consistent behavior across different .NET environments. This change may impact tests that rely on specific timeout values, especially if those tests are asynchronous or run under different frameworks.
148148
149-
- In MSTest v1 or v2, certain timeout settings might have been interpreted differently depending on the framework (e.g., .NET Framework vs. .NET Core).
149+
- In MSTest v1 or v2, certain timeout settings might have been interpreted differently depending on the framework (for example, .NET Framework vs. .NET Core).
150150
- MSTest v3 enforces consistent timeout behavior, which might mean that tests configured with timeouts in previous versions may fail or behave differently if the timeout values are too short under the new standard.
151151
152152
**What This Means**:
@@ -166,7 +166,7 @@ public void TestMethod() { ... }
166166
// New (v3) - Unified handling of timeout
167167
[TestMethod]
168168
[Timeout(2000)] // Verify this value still works under MSTest v3
169-
public async Task TestMethod() { ... }
169+
public async Task TestMethod() { ... }
170170
```
171171
172172
## Configuration changes

docs/csharp/delegate-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The compiler generates a class, derived from `System.Delegate`
3838
that matches the signature used (in this case, a method that
3939
returns an integer, and has two arguments). The type
4040
of that delegate is `Comparison`. The `Comparison` delegate
41-
type is a generic type. For details on generics see [here](fundamentals/types/generics.md).
41+
type is a generic type. For more information, see [Generic classes and methods](./fundamentals/types/generics.md).
4242

4343
Notice that the syntax may appear as though it is declaring
4444
a variable, but it is actually declaring a *type*. You can

0 commit comments

Comments
 (0)