Skip to content

Commit

Permalink
Document usage of Clang-Format formatting tool.
Browse files Browse the repository at this point in the history
  • Loading branch information
AndreiPashkin committed Sep 22, 2020
1 parent f619827 commit ae98fd1
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/source/Development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,3 +98,26 @@ To format code::
To check code formatting::

tox -e black -- --check

C++
...

Clang-Format
~~~~~~~~~~~~
Clang-Format_ is a formatting tool for C++ and other languages.

.. _Clang-Format: https://clang.llvm.org/docs/ClangFormat.html

Usage
*****
Before running any commands it's needed to generate build system::

cmake .

Then - to format code::

make clang-format

To check code formatting::

make clang-format-check

0 comments on commit ae98fd1

Please sign in to comment.