Skip to content

Commit 9b81805

Browse files
authored
Markdown lint fixes (#530)
* enable MD030 * fix MD030 These should all be whitespace-only changes. * enable MD032 * skip 31, that will be a single PR. Use 32 * Fix MD032 Most of these are notes and examples. In most cases, the trailing *end note* was on a separate line not separated by a blank line. In many, they were at the end of the last bullet item. I normalized all to be on the last bullet item. * Enable MD036 * re-disable MD036. Enable MD037 * Remove extra space in italicized words. * enable MD038 * Fix MD038 These are inline code fences where one of the back-ticks was either missing, or misplaced. * enable MD040 * Fix MD040 The only occurrences are in the tools/GetGrammar folder. These files are added by the tool, and insert the closing codefence. They are false positives. So, disable checking in that folder. We'll catch any mistakes there by linting the tool output on the automated PRs. * enable MD041 * Update yml Caught while testing. * enable MD047 * enable MD050 * Fix MD050 Strong style should be consistent.
1 parent b6412f4 commit 9b81805

19 files changed

+692
-711
lines changed

.github/workflows/markdownlint.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ on:
55
branches:
66
- draft-v6
77
paths:
8-
- "**/*.md"
8+
- "standard/*.md"
99
- ".markdownlint.json"
1010
pull_request:
1111
paths:
12-
- "**/*.md"
12+
- "standard/*.md"
1313
- ".markdownlint.json"
1414
workflow_dispatch:
1515
inputs:
@@ -35,4 +35,4 @@ jobs:
3535
run: |
3636
echo "::add-matcher::.github/workflows/markdownlint-problem-matcher.json"
3737
npm i -g markdownlint-cli
38-
markdownlint "**/*.md"
38+
markdownlint "standard/*.md"

.markdownlint.json

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
"default": true,
33
"MD013": false,
44
"MD033": false,
5-
"MD034" : false,
5+
"MD034": false,
6+
"MD036": false,
67
"MD046": {
78
"style": "fenced"
89
},
@@ -12,16 +13,5 @@
1213
]
1314
},
1415

15-
"MD030" : false,
16-
"MD031" : false,
17-
"MD032" : false,
18-
"MD036" : false,
19-
"MD037" : false,
20-
"MD038" : false,
21-
"MD040" : false,
22-
"MD041" : false,
23-
"MD047" : false,
24-
"MD050" : false
25-
26-
16+
"MD031" : false
2717
}

standard/arrays.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ The rank of an array type is given by the leftmost *rank_specifier* in the *arra
3636
3737
The element type of an array type is the type that results from deleting the leftmost *rank_specifier*:
3838
39-
- An array type of the form `T[R]` is an array with rank `R` and a non-array element type `T`.
40-
- An array type of the form `T[R][R₁]...[Rₓ]` is an array with rank `R` and an element type `T[R₁]...[Rₓ]`.
39+
- An array type of the form `T[R]` is an array with rank `R` and a non-array element type `T`.
40+
- An array type of the form `T[R][R₁]...[Rₓ]` is an array with rank `R` and an element type `T[R₁]...[Rₓ]`.
4141
4242
In effect, the *rank_specifier*s are read from left to right *before* the final non-array element type.
4343

standard/attributes.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -446,7 +446,7 @@ Retrieval of an attribute instance involves both compile-time and run-time proce
446446
447447
### 21.4.2 Compilation of an attribute
448448
449-
The compilation of an *attribute* with attribute class `T`, *positional_argument_list * `P`, *named_argument_list* `N`, and specified on a program entity `E` is compiled into an assembly `A` via the following steps:
449+
The compilation of an *attribute* with attribute class `T`, *positional_argument_list* `P`, *named_argument_list* `N`, and specified on a program entity `E` is compiled into an assembly `A` via the following steps:
450450
451451
- Follow the compile-time processing steps for compiling an *object_creation_expression* of the form new `T(P)`. These steps either result in a compile-time error, or determine an instance constructor `C` on `T` that can be invoked at run-time.
452452
- If `C` does not have public accessibility, then a compile-time error occurs.
@@ -455,7 +455,7 @@ The compilation of an *attribute* with attribute class `T`, *positional_argumen
455455
- `Name` shall identify a non-static read-write public field or property on `T`. If `T` has no such field or property, then a compile-time error occurs.
456456
- If any of the values within *positional_argument_list* `P` or one of the values within *named_argument_list* `N` is of type `System.String` and the value is not well-formed as defined by the Unicode Standard, it is implementation-defined whether the value compiled is equal to the run-time value retrieved ([§21.4.3](attributes.md#2143-run-time-retrieval-of-an-attribute-instance)).
457457
> *Note*: As an example, a string which contains a high surrogate UTF-16 code unit which isn’t immediately followed by a low surrogate code unit is not well-formed. *end note*
458-
- Store the following information (for run-time instantiation of the attribute) in the assembly output by the compiler as a result of compiling the program containing the attribute: the attribute class `T`, the instance constructor `C` on `T`, the *positional_argument_list * `P`, the *named_argument_list* `N`, and the associated program entity `E`, with the values resolved completely at compile-time.
458+
- Store the following information (for run-time instantiation of the attribute) in the assembly output by the compiler as a result of compiling the program containing the attribute: the attribute class `T`, the instance constructor `C` on `T`, the *positional_argument_list* `P`, the *named_argument_list* `N`, and the associated program entity `E`, with the values resolved completely at compile-time.
459459
460460
### 21.4.3 Run-time retrieval of an attribute instance
461461
@@ -467,7 +467,7 @@ The attribute instance represented by `T`, `C`, `P`, and `N`, and associated wi
467467
- Let `Value` be the result of evaluating the *attribute_argument_expression* of `Arg`.
468468
- If `Name` identifies a field on `O`, then set this field to `Value`.
469469
- Otherwise, Name identifies a property on `O`. Set this property to Value.
470-
- The result is `O`, an instance of the attribute class `T` that has been initialized with the *positional_argument_list * `P` and the *named_argument_list* `N`.
470+
- The result is `O`, an instance of the attribute class `T` that has been initialized with the *positional_argument_list* `P` and the *named_argument_list* `N`.
471471
472472
> *Note*: The format for storing `T`, `C`, `P`, `N` (and associating it with `E`) in `A` and the mechanism to specify `E` and retrieve `T`, `C`, `P`, `N` from `A` (and hence how an attribute instance is obtained at runtime) is beyond the scope of this standard. *end note*
473473
<!-- markdownlint-disable MD028 -->

0 commit comments

Comments
 (0)