@@ -96,7 +96,7 @@ Most IDEs support this type of file, which can and should be used to apply unifo
9696code styling to C++ source and header files.
9797- _ For Python wrapper repositories_ , a ` .pre-commit-config.yaml ` file is included
9898in the root directory. This file implements multiple hooks for the [ pre-commit] ( https://pre-commit.com/ )
99- tool, which apply automated formatting to files when they are commited to Git.
99+ tool, which apply automated formatting to files when they are committed to Git.
100100It is recommended to use this tool to autoformat Python code when checked in.
101101
102102## Project Structure and CMake
@@ -134,7 +134,7 @@ wrap/
134134 matlab/ # MATLAB wrapper submodule. Should contain CMakeLists.txt
135135 python/ # Python wrapper submodule. Should contain CMakeLists.txt
136136CMakeLists.txt # Top-level CMakeLists.txt: project metadata and options
137- CMakePresets.json # Presets for CMake, e.g. "release64 ", "debug64 ", etc.
137+ CMakePresets.json # Presets for CMake, e.g. "release ", "debug ", etc.
138138...
139139```
140140
@@ -172,7 +172,7 @@ the Debug configuration will attempt to pass debug flags to the compiler.
172172The provided ` CMakeLists.txt ` and ` CMakePresets.json ` files aim to be flexible
173173for development from the platform of your choosing. The approach taken is to make
174174few assumptions about your toolchain to implicitly enable cross-platform and
175- multi-environment development as much as possible. However, we cannnot guarantee
175+ multi-environment development as much as possible. However, we cannot guarantee
176176that all compilers, tools, and platforms will work without requiring some additional
177177configuration which is not documented here. If you find an issue or would like to
178178see a change to support your chosen platform or tools, open an issue or create a
@@ -186,11 +186,11 @@ The C++ source code is documented with Doxygen. A GitHub Action is configured to
186186build and deploy the documentation using GitHub Pages. This action will ensure
187187that any new code has been accompanied by Doxygen-formatted documentation. Code
188188will not be merged until and unless it is completely documented using Doxygen,
189- and the GitHub action succesfully generates the documentation site. Below is an
189+ and the GitHub action successfully generates the documentation site. Below is an
190190example showing the expected documentation formats.
191191
192192``` cpp
193- # define PI 3.1415 /** < Inline doxygen format, e.g. for macros or struct members * /
193+ constexpr double = PI 3.1415 ; /* *< Inline format, e.g. for constants or struct members */
194194
195195/* ******************************************************************************
196196 * This is a brief description of the function.
0 commit comments