Skip to content

Commit 3e514a9

Browse files
committed
Further lint fixes for README
Break up shell commands Fix length of list entry
1 parent de6bb0b commit 3e514a9

File tree

2 files changed

+13
-3
lines changed

2 files changed

+13
-3
lines changed

.markdownlint.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,7 @@ MD033: false
88
MD013:
99
line_length: 119
1010

11+
# MD024/no-duplicate-heading : https://github.com/DavidAnson/markdownlint/blob/main/doc/md024.md
12+
# Supress warning about the same heading twice unless they are in the same block
1113
MD024:
1214
siblings_only: true

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,10 @@ CI current build and test flows:
203203

204204
```shell
205205
# Configure build: default build production code + tests (BUILD_TESTING=ON by default).
206-
$ cmake -G "Ninja Multi-Config" -DCMAKE_CONFIGURATION_TYPES="RelWithDebInfo;Asan" -DCMAKE_TOOLCHAIN_FILE=etc/clang-19-toolchain.cmake -B .build -S .
206+
$ cmake -G "Ninja Multi-Config" \
207+
-DCMAKE_CONFIGURATION_TYPES="RelWithDebInfo;Asan" \
208+
-DCMAKE_TOOLCHAIN_FILE=etc/clang-19-toolchain.cmake \
209+
-B .build -S .
207210
-- The CXX compiler identification is Clang 19.0.0
208211
...
209212
-- Build files have been written to: /path/to/Optional26/.build
@@ -229,7 +232,11 @@ By default, we build and run tests. You can provide `-DBUILD_TESTING=OFF` and co
229232

230233
```shell
231234
# Configure build: build production code, skip tests (BUILD_TESTING=OFF).
232-
$ cmake -G "Ninja Multi-Config" -DCMAKE_CONFIGURATION_TYPES="RelWithDebInfo;Asan" -DCMAKE_TOOLCHAIN_FILE=etc/clang-19-toolchain.cmake -DBUILD_TESTING=OFF -B .build -S .
235+
$ cmake -G "Ninja Multi-Config" \
236+
-DCMAKE_CONFIGURATION_TYPES="RelWithDebInfo;Asan" \
237+
-DCMAKE_TOOLCHAIN_FILE=etc/clang-19-toolchain.cmake \
238+
-DBUILD_TESTING=OFF \
239+
-B .build -S .
233240
-- The CXX compiler identification is Clang 19.0.0
234241
...
235242
-- Build files have been written to: /path/to/Optional26/.build
@@ -289,7 +296,8 @@ make lint
289296

290297
Latest revision(s) of the papers can be built / found at:
291298

292-
* [give-std-optional-range-support](https://github.com/neatudarius/give-std-optional-range-support/) for `Give *std::optional* Range Support (P3168)`
299+
* [give-std-optional-range-support](https://github.com/neatudarius/give-std-optional-range-support/) for
300+
`Give *std::optional* Range Support (P3168)`
293301
* issue: [#1831](https://github.com/cplusplus/papers/issues/1831)
294302
* LEWG:
295303
* Reviewed in Tokyo 2024.

0 commit comments

Comments
 (0)