Skip to content

Commit 8cad185

Browse files
committed
Add note about using clang-format to the internals document
1 parent 75e5af8 commit 8cad185

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

vignettes/internals.Rmd

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,12 @@ To calculate code coverage of the cpp11 package run the following from the `cpp1
5454
covr::report(cpp11_coverage())
5555
```
5656

57+
## Code formatting
58+
59+
This project uses [clang-format](https://clang.llvm.org/docs/ClangFormat.html) to automatically format the c++ code.
60+
61+
You can run `make format` to re-format all code in the project. Alternatively many IDEs support automatically running `clang-format` every time files are written.
62+
5763
## Code organization
5864

5965
cpp11 is a header only library, so all source code exposed to users lives in [inst/include](https://github.com/r-lib/cpp11/tree/master/inst/include).

0 commit comments

Comments
 (0)