From 8b5ed5f12dd0907ae265e489253ef824f48cbae1 Mon Sep 17 00:00:00 2001 From: Paul Romano Date: Mon, 27 Jan 2020 22:05:20 -0600 Subject: [PATCH] All note in style guide about using clang-format --- docs/source/devguide/styleguide.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/source/devguide/styleguide.rst b/docs/source/devguide/styleguide.rst index 562b75e89..a46744a3f 100644 --- a/docs/source/devguide/styleguide.rst +++ b/docs/source/devguide/styleguide.rst @@ -12,6 +12,14 @@ adding new code in OpenMC. C++ --- +.. important:: To ensure consistent styling with little effort, this project + uses `clang-format `_. The + repository contains a ``.clang-format`` file that can be used to + automatically apply the style rules that are described below. The easiest + way to use clang-format is through a plugin/extension for your editor/IDE + that automatically runs clang-format using the ``.clang-format`` file + whenever a file is saved. + Indentation -----------