Skip to content

Commit

Permalink
Merge pull request #6 from openMSL/5-link-not-displayed-correctly-in-…
Browse files Browse the repository at this point in the history
…cl-11-c+-linter

Fix link issue due to special characters '++'
  • Loading branch information
adineh authored Mar 21, 2024
2 parents 176eb65 + 6081db8 commit 3dd9e21
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/modules/test-architecture/pages/cl1.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Credibility assessment level 1 contains multiple different tests for code quality.
In the first test, linters are used to ensure general quality of code and documentation.
In the example linked below, linters for C++ code, markdown files, and xml files such as SRMD and modelDescription are implemented.
In the example linked below, linters for C++ code, markdown files, and xml files such as SRMD and modelDescription are implemented.
Further linters have to be added, if additional programming languages are used.
In the second test, the model is build using cmake.
The third test category runs unit tests defined for the individual model.
Expand All @@ -15,9 +15,9 @@ These tests consist of linters checking the formatting against style guides for

### C++ Linter

C++ code is checked with clang according to the clang-format and clang-tidy files in the repository.
C++ code is checked with clang according to the clang-format and clang-tidy files in the repository.
It is mandatory for every code repository to provide these config files.
As a best practice, https://github.com/eklitzke/clang-format-all[clang-format-all] can be used to automatically format all C++ files in the repository.
As a best practice, https://github.com/eklitzke/clang-format-all[clang-format-all] can be used to automatically format all C++ files in the repository.
Be aware, that formatting might break functionality, e.g. by a different order of includes.
Be sure to check after formatting.

Expand Down

0 comments on commit 3dd9e21

Please sign in to comment.