Skip to content

Commit 35b98c3

Browse files
committed
Fix markdownlint issues
1 parent 5bda214 commit 35b98c3

File tree

4 files changed

+16
-16
lines changed

4 files changed

+16
-16
lines changed

.markdownlint.jsonc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
{
22
// MD001/heading-increment : Heading levels should only increment by one level at a time
3-
"MD001": false,
3+
"MD001": true,
44

55
// MD004/ul-style : Unordered list style
66
"MD004": false,
77

88
// MD012/no-multiple-blanks : Multiple consecutive blank lines
9-
"MD012": false,
9+
"MD012": true,
1010

1111
// MD013/line-length : Line length
1212
"MD013": false,
@@ -18,26 +18,26 @@
1818
"MD029": false,
1919

2020
// MD031/blanks-around-fences : Fenced code blocks should be surrounded by blank lines
21-
"MD031": false,
21+
"MD031": true,
2222

2323
// MD033/no-inline-html : Inline HTML
24-
"MD033": false,
24+
"MD033": true,
2525

2626
// MD034/no-bare-urls : Bare URL used
2727
"MD034": false,
2828

2929
// MD036/no-emphasis-as-heading : Emphasis used instead of a heading
30-
"MD036": false,
30+
"MD036": true,
3131

3232
// MD047/single-trailing-newline : Files should end with a single newline character
33-
"MD047": false,
33+
"MD047": true,
3434

3535
// MD051/link-fragments : Link fragments should be valid
36-
"MD051": false,
36+
"MD051": true,
3737

3838
// MD052/reference-links-images : Reference links and images should use a label that is defined
39-
"MD052": false,
39+
"MD052": true,
4040

4141
// MD059/descriptive-link-text : Link text should be descriptive
42-
"MD059": false
42+
"MD059": true
4343
}

docs/benchmarkdotnet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -369,7 +369,7 @@ So if you made a change in CLR and want to measure the difference, you can run t
369369
dotnet run -c Release -f net48 -- --clrVersion $theVersion
370370
```
371371

372-
More info can be found [here](https://github.com/dotnet/BenchmarkDotNet/issues/706).
372+
More info can be found in [BenchmarkDotNet issue #706](https://github.com/dotnet/BenchmarkDotNet/issues/706).
373373

374374
### Private CoreRT Build
375375

src/benchmarks/gc/GC.Infrastructure/Notebooks/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This directory contains notebooks that either provide examples or functionality
44

55
## Prerequisites
66

7-
1. Install the latest version of VSCode from [here](https://code.visualstudio.com/).
7+
1. Install the latest version of [VSCode](https://code.visualstudio.com/).
88
2. Install the [Polyglot Notebooks](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.dotnet-interactive-vscode) Extension. To learn more about installing Notebook Extensions refer to [this](https://code.visualstudio.com/learn/get-started/extensions) page.
99

1010
## Examples

src/benchmarks/gc/GC.Infrastructure/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This section details the end-to-end workflow associated with getting the infrast
1717
1. Clone the performance repo: ``git clone https://github.com/dotnet/performance C:\performance\``.
1818
2. Install:
1919
1. The Dotnet 7 SDK.
20-
1. The link to the installers can be found [here](https://dotnet.microsoft.com/en-us/download/dotnet/7.0).
20+
1. The [Download .NET 7.0 page](https://dotnet.microsoft.com/en-us/download/dotnet/7.0) contains the installers.
2121
2. [crank](https://github.com/dotnet/crank)
2222
1. crank can be installed by invoking: ``dotnet tool install Microsoft.Crank.Controller --version "0.2.0-*" --global``.
2323
3. Ensure that your machine can connected to Corp Net for the ASP.NET Scenarios. You can still run GCPerfSim and Microbenchmark test suites without being connected to Corp Net.
@@ -82,7 +82,7 @@ To run GCPerfSim on the ASP.NET Machines, do the following:
8282
2. ``sc.exe create "CrankAgentService" binpath= "%USERPROFILE%\crank-agent.exe --url http://*:5001 --service"``.
8383
2. Then run the crank-agent by invoking ``crank-agent`` locally.
8484

85-
The list of machines you can choose to run the configuration can be found [here](https://github.com/aspnet/Benchmarks/tree/main/scenarios#profiles).
85+
The list of machines you can choose to run the configuration can be found in the [ASP.NET Core Benchmark Scenarios documentation](https://github.com/aspnet/Benchmarks/tree/main/scenarios#profiles).
8686

8787
##### Microbenchmarks
8888

@@ -139,7 +139,7 @@ To run the infrastructure on a specific set of ASP.NET Benchmarks, do the follow
139139
1. ``cd C:\performance\artifacts\bin\GC.Infrastructure\Release\net7.0\``.
140140
2. ``.\GC.Infrastructure.exe aspnetbenchmarks --configuration C:\performance\src\benchmarks\gc\GC.Infrastructure\Configurations\ASPNetBenchmarks\ASPNetBenchmarks.yaml``.
141141

142-
More details about running and troubleshooting ASP.NET benchmarks can be found [here](./docs/ASPNETBenchmarks.md).
142+
More details about running and troubleshooting ASP.NET benchmarks can be found in the [ASP.NET Benchmarks guide](./docs/ASPNETBenchmarks.md).
143143

144144
###### Uploading Your Own Binaries
145145

@@ -181,7 +181,7 @@ runs:
181181

182182
###### Updating Which Benchmarks to Run
183183

184-
The file that dictates which ASP.NET benchmarks to run is a CSV file and can be configured based on what test you need to run; an example of this file can be found [here](./Configurations/ASPNetBenchmarks/ASPNetBenchmarks.csv).
184+
The file that dictates which ASP.NET benchmarks to run is a CSV file and can be configured based on what test you need to run; an example is provided in [ASPNetBenchmarks.csv](./Configurations/ASPNetBenchmarks/ASPNetBenchmarks.csv).
185185

186186
You can update this file by changing the following field:
187187

@@ -197,7 +197,7 @@ The format of this file is:
197197
where:
198198

199199
1. Legend column should contain the name of the ASP.NET benchmark followed by an underscore and the name of the OS.
200-
2. The Base CommandLine is the base crank command that's run. More details about how to appropriately set this can be found [here](#how-to-add-new-benchmarks).
200+
2. The Base CommandLine is the base crank command that's run. More details about how to appropriately set this can be found in the next section.
201201

202202
It's worth noting that if you have specified Linux based binaries in the corerun path, the Windows based ASP.NET benchmarks will exhibit undefined behavior.
203203

0 commit comments

Comments
 (0)