Skip to content

Commit b3c209c

Browse files
committed
docs: indentiation fixed in a contributing guide
1 parent 79f42e8 commit b3c209c

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

CONTRIBUTING.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88
If you are looking for a good issue to start with, please check the following:
99

1010
- [good first issue](https://github.com/mpusz/mp-units/labels/good%20first%20issue) - issues that
11-
should be pretty simple to implement,
11+
should be pretty simple to implement,
1212
- [help wanted](https://github.com/mpusz/mp-units/labels/help%20wanted) - issues that typically are
13-
a bit more involved than beginner issues,
13+
a bit more involved than beginner issues,
1414
- [high priority](https://github.com/mpusz/mp-units/labels/high%20priority) - things to fix ASAP
15-
but often of higher complexity.
15+
but often of higher complexity.
1616

1717

1818
## Gitpod
@@ -46,28 +46,28 @@ if you want to set up a development environment on your local machine.
4646

4747
[`user.mp-units.build:all`](#user.mp-units.build-all){ #user.mp-units.build-all }
4848

49-
Enables compilation of all the source code, including tests and examples. To support this, it requires some additional Conan build dependencies described in
50-
[Repository directory tree and dependencies](https://mpusz.github.io/mp-units/latest/getting_started/project_structure#cmake-projects-and-dependencies).
51-
It also runs unit tests during the Conan build (unless
52-
[`tools.build:skip_test`](https://docs.conan.io/2/reference/commands/config.html?highlight=tools.build:skip_test#conan-config-list)
53-
configuration property is set to `True`).
49+
: Enables compilation of all the source code, including tests and examples. To support this, it requires some additional Conan build dependencies described in
50+
[Repository directory tree and dependencies](https://mpusz.github.io/mp-units/latest/getting_started/project_structure#cmake-projects-and-dependencies).
51+
It also runs unit tests during the Conan build (unless
52+
[`tools.build:skip_test`](https://docs.conan.io/2/reference/commands/config.html?highlight=tools.build:skip_test#conan-config-list)
53+
configuration property is set to `True`).
5454

55-
[conan build all support]: https://github.com/mpusz/mp-units/releases/tag/v2.2.0
55+
[conan build all support]: https://github.com/mpusz/mp-units/releases/tag/v2.2.0
5656

5757
[`user.mp-units.build:skip_la`](#user-skip-la){ #user-skip-la }
5858

59-
If `user.mp-units.build:all` is enabled, among others, Conan installs the external
60-
[wg21-linear_algebra](https://conan.io/center/recipes/wg21-linear_algebra)
61-
dependency and enables the compilation of linear algebra-based tests and usage examples.
62-
Such behavior can be disabled with this option.
59+
: If `user.mp-units.build:all` is enabled, among others, Conan installs the external
60+
[wg21-linear_algebra](https://conan.io/center/recipes/wg21-linear_algebra)
61+
dependency and enables the compilation of linear algebra-based tests and usage examples.
62+
Such behavior can be disabled with this option.
6363

64-
[conan skip la support]: https://github.com/mpusz/mp-units/releases/tag/v2.2.0
64+
[conan skip la support]: https://github.com/mpusz/mp-units/releases/tag/v2.2.0
6565

6666
[`user.mp-units.analyze:clang-tidy`](#user.mp-units.analyze-clang-tidy){ #user.mp-units.analyze-clang-tidy }
6767

68-
Enables clang-tidy analysis.
68+
: Enables clang-tidy analysis.
6969

70-
[conan clang-tidy support]: https://github.com/mpusz/mp-units/releases/tag/v2.2.0
70+
[conan clang-tidy support]: https://github.com/mpusz/mp-units/releases/tag/v2.2.0
7171

7272

7373
### CMake options for mp-units project developers
@@ -76,25 +76,25 @@ if you want to set up a development environment on your local machine.
7676

7777
:   [:octicons-tag-24: 2.2.0][cmake build la support] · :octicons-milestone-24: `ON`/`OFF` (Default: `ON`)
7878

79-
Enables building code depending on the linear algebra library.
79+
Enables building code depending on the linear algebra library.
8080

81-
[cmake build la support]: https://github.com/mpusz/mp-units/releases/tag/v2.2.0
81+
[cmake build la support]: https://github.com/mpusz/mp-units/releases/tag/v2.2.0
8282

8383
[`MP_UNITS_DEV_IWYU`](#MP_UNITS_DEV_IWYU){ #MP_UNITS_DEV_IWYU }
8484

8585
:   [:octicons-tag-24: 2.2.0][cmake iwyu support] · :octicons-milestone-24: `ON`/`OFF` (Default: `OFF`)
8686

87-
Enables include-what-you-use analysis.
87+
Enables include-what-you-use analysis.
8888

89-
[cmake iwyu support]: https://github.com/mpusz/mp-units/releases/tag/v2.2.0
89+
[cmake iwyu support]: https://github.com/mpusz/mp-units/releases/tag/v2.2.0
9090

9191
[`MP_UNITS_DEV_CLANG_TIDY`](#MP_UNITS_DEV_CLANG_TIDY){ #MP_UNITS_DEV_CLANG_TIDY }
9292

9393
:   [:octicons-tag-24: 2.2.0][cmake clang-tidy support] · :octicons-milestone-24: `ON`/`OFF` (Default: `OFF`)
9494

95-
Enables clang-tidy analysis.
95+
Enables clang-tidy analysis.
9696

97-
[cmake clang-tidy support]: https://github.com/mpusz/mp-units/releases/tag/v2.2.0
97+
[cmake clang-tidy support]: https://github.com/mpusz/mp-units/releases/tag/v2.2.0
9898

9999

100100
### Building the entire repository
@@ -167,15 +167,15 @@ After that, you can either:
167167

168168
- easily [start a live server to preview the documentation as you write](https://squidfunk.github.io/mkdocs-material/creating-your-site/#previewing-as-you-write)
169169

170-
```shell
171-
mkdocs serve
172-
```
170+
```shell
171+
mkdocs serve
172+
```
173173

174174
- [build the documentation](https://squidfunk.github.io/mkdocs-material/creating-your-site/#building-your-site)
175175

176-
```shell
177-
mkdocs build
178-
```
176+
```shell
177+
mkdocs build
178+
```
179179

180180
### Generating API reference
181181

0 commit comments

Comments
 (0)