Skip to content

Commit 000fe24

Browse files
wermoswermos
committed
Fixed formatting.
1 parent b0bc2b0 commit 000fe24

File tree

2 files changed

+45
-17
lines changed

2 files changed

+45
-17
lines changed

‎README.md‎

Lines changed: 43 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -18,24 +18,32 @@ Source is licensed with the Apache 2.0 license with LLVM exceptions
1818

1919
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
2020

21-
Documentation and associated papers are licensed with the Creative Commons Attribution 4.0 International license.
21+
Documentation and associated papers are licensed with the Creative Commons
22+
Attribution 4.0 International license.
2223

2324
// SPDX-License-Identifier: CC-BY-4.0
2425

25-
The intent is that the source and documentation are available for use by people implementing their iterator types.
26+
The intent is that the source and documentation are available for use by people
27+
implementing their iterator types.
2628

27-
The README itself is licensed with CC0 1.0 Universal. Copy the contents and incorporate in your own work as you see fit.
29+
The README itself is licensed with CC0 1.0 Universal. Copy the contents and
30+
incorporate in your own work as you see fit.
2831

2932
// SPDX-License-Identifier: CC0-1.0
3033

3134
## Examples
3235

33-
Full runnable examples can be found in `examples/` - please check [examples/README.md](./examples/README.md) for building the code on local setup or on Compiler Explorer.
36+
Full runnable examples can be found in `examples/` - please check
37+
[examples/README.md](./examples/README.md) for building the code on local setup
38+
or on Compiler Explorer.
3439

3540
### Repeated Chars Iterator
3641

37-
The next code snippet shows iterator interface support added in [`std::iterator_interface` (P2727R)](https://wg21.link/P2727R4): define a random access iterator that iterates over a sequence of characters repeated indefinitely.
42+
The next code snippet shows iterator interface support added in
43+
[`std::iterator_interface` (P2727R)](https://wg21.link/P2727R4): define a random
44+
access iterator that iterates over a sequence of characters repeated indefinitely.
3845

46+
<!-- markdownlint-disable -->
3947
```cpp
4048
#include <beman/iterator_interface/iterator_interface.hpp>
4149

@@ -87,11 +95,16 @@ std::copy(it_first, it_last, std::back_inserter(extracted_result));
8795
assert(extracted_result.size() == len);
8896
std::cout << extracted_result << "\n"; // Expected output at STDOUT: "foofoof"
8997
```
98+
<!-- markdownlint-enable -->
9099
91100
### Filter Integer Iterator
92101
93-
The next code snippet shows iterator interface support added in [`std::iterator_interface` (P2727R4)](https://wg21.link/P2727R4): define a forward iterator that iterates over a sequence of integers, skipping those that do not satisfy a predicate.
102+
The next code snippet shows iterator interface support added in
103+
[`std::iterator_interface` (P2727R4)](https://wg21.link/P2727R4): define a
104+
forward iterator that iterates over a sequence of integers, skipping those that
105+
do not satisfy a predicate.
94106
107+
<!-- markdownlint-disable -->
95108
```cpp
96109
#include <beman/iterator_interface/iterator_interface.hpp>
97110
@@ -116,19 +129,21 @@ while (*it) {
116129
}
117130
std::cout << "\n";
118131
```
132+
<!-- markdownlint-enable -->
119133

120134
## How to Build
121135

122136
### Compiler Support
123137

124-
This is a modern C++ project which can be compiled with the latest C++ standards (**C++20 or later**).
138+
This is a modern C++ project which can be compiled with the latest C++ standards
139+
(**C++20 or later**).
125140

126141
Default build: `C++23`. Please check `etc/${compiler}-flags.cmake`.
127142

128143
### Dependencies
129144

130-
This project is mainly tested on `Ubuntu 22.04` and `Ubuntu 24.04`, but it should be as portable as CMake is. This
131-
project has no C or C++ dependencies.
145+
This project is mainly tested on `Ubuntu 22.04` and `Ubuntu 24.04`, but it
146+
should be as portable as CMake is. This project has no C or C++ dependencies.
132147

133148
Build-time dependencies:
134149

@@ -152,9 +167,11 @@ apt-get install \
152167

153168
#### Preset CMake Workflows
154169

155-
This project strives to be as normal and simple a CMake project as possible. This build workflow in particular will
156-
work, producing a static `beman.iterator_interface` library, ready to package:
170+
This project strives to be as normal and simple a CMake project as possible. This
171+
build workflow in particular will work, producing a static
172+
`beman.iterator_interface` library, ready to package:
157173

174+
<!-- markdownlint-disable -->
158175
```shell
159176
$ cmake --workflow --preset gcc-debug
160177
$ cmake --workflow --preset gcc-release
@@ -183,10 +200,12 @@ $ tree /opt/beman.iterator_interface
183200

184201
<details>
185202
<summary> Build beman.iterator_interface (verbose logs - gcc-debug) </summary>
203+
<!-- markdownlint-enable -->
186204

205+
This should build and run the tests with system GCC with the address and
206+
undefined behavior sanitizers enabled.
187207

188-
This should build and run the tests with system GCC with the address and undefined behavior sanitizers enabled.
189-
208+
<!-- markdownlint-disable -->
190209
```shell
191210
$ cmake --workflow --preset gcc-debug
192211
Executing workflow step 1 of 3: configure preset "gcc-debug"
@@ -239,10 +258,11 @@ Test project /path/to/repo/.build/gcc-debug
239258

240259
Total Test time (real) = 0.04 sec
241260
```
261+
<!-- markdownlint-enable -->
242262

243263
</details>
244264

245-
265+
<!-- markdownlint-disable -->
246266
<details>
247267
<summary> Install beman.iterator_interface (verbose logs - gcc-release) </summary>
248268

@@ -332,8 +352,8 @@ $ tree /opt/beman.iterator_interface
332352
└── libbeman.iterator_interface.a
333353

334354
8 directories, 9 files
335-
336355
```
356+
<!-- markdownlint-enable -->
337357

338358
</details>
339359

@@ -342,6 +362,7 @@ $ tree /opt/beman.iterator_interface
342362
##### Default Build
343363

344364
CI current build and test flows:
365+
345366
```shell
346367
# Configure.
347368
$ cmake -G "Ninja Multi-Config" \
@@ -391,8 +412,10 @@ $ tree /opt/beman.iterator_interface
391412
8 directories, 9 files
392413
```
393414

415+
<!-- markdownlint-disable -->
394416
<details>
395417
<summary> Build beman.iterator_interface and tests (verbose logs) </summary>
418+
<!-- markdownlint-enable -->
396419

397420
```shell
398421
# Configure build: default build production code + tests (BEMAN_ITERATOR_INTERFACE_BUILD_TESTING=ON).
@@ -418,11 +441,13 @@ Test project /path/to/repo/.build
418441

419442
Total Test time (real) = 0.67 sec
420443
```
444+
421445
</details>
422446

423447
##### Skip Tests
424448

425-
By default, we build and run tests. You can provide `-DBEMAN_ITERATOR_INTERFACE_BUILD_TESTING=OFF` and completely disable building tests:
449+
By default, we build and run tests. You can provide
450+
`-DBEMAN_ITERATOR_INTERFACE_BUILD_TESTING=OFF` and completely disable building tests:
426451

427452
```shell
428453
# Configure.
@@ -435,7 +460,8 @@ $ cmake -G "Ninja Multi-Config" \
435460

436461
##### Skip Examples
437462

438-
By default, we build and run tests. You can provide `-DBEMAN_ITERATOR_INTERFACE_BUILD_EXAMPLES=OFF` and completely disable building tests:
463+
By default, we build and run tests. You can provide
464+
`-DBEMAN_ITERATOR_INTERFACE_BUILD_EXAMPLES=OFF` and completely disable building tests:
439465

440466
```shell
441467
# Configure.

‎examples/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,10 @@ List of usage examples for `beman.iterator_interface`.
1010

1111
Check basic `beman.iterator_interface` library usages:
1212

13+
<!-- markdownlint-disable -->
1314
* [P2727](https://wg21.link/P2727): local [./repeated_chars_iterator.cpp](./repeated_chars_iterator.cpp) or [repeated_chars_iterator.cpp@Compiler Explorer](https://godbolt.org/z/Yn9K15c9b)
1415
* [P2727](https://wg21.link/P2727): local [./filter_int_iterator.cpp](./filter_int_iterator.cpp) or [filter_int_iterator.cpp@Compiler Explorer](https://godbolt.org/z/q6933enqe)
16+
<!-- markdownlint-enable -->
1517

1618
## Local Build and Run
1719

0 commit comments

Comments
 (0)