Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gardner48 committed Jun 30, 2024
1 parent 2477d0d commit fede229
Showing 1 changed file with 12 additions and 13 deletions.
25 changes: 12 additions & 13 deletions doc/superbuild/source/developers/style_guide/SourceCode.rst
Original file line number Diff line number Diff line change
Expand Up @@ -184,12 +184,11 @@ not adhere to all of these rules.
variable-length arrays. Exceptions are allowed when interfacing with a
library which requires a newer standard.

#. All new code added to SUNDIALS should be formatted with
`clang-format <https://clang.llvm.org/docs/ClangFormat.html>`_ for C/C++
files and `fprettify <https://github.com/fortran-lang/fprettify>`_ for
Fortran files. New CMake files should be formatted with
`clang-format <https://cmake-format.readthedocs.io>`_.
See :ref:`Style.Formatting` for details.
#. All new code added to SUNDIALS should be formatted with `clang-format
<https://clang.llvm.org/docs/ClangFormat.html>`_ for C/C++, `fprettify
<https://github.com/fortran-lang/fprettify>`_ for Fortran, and `cmake-format
<https://cmake-format.readthedocs.io>`_ for CMake. See
:ref:`Style.Formatting` for details.

#. Spaces not tabs.

Expand Down Expand Up @@ -380,13 +379,13 @@ Formatting
----------

All new code added to SUNDIALS should be formatted with `clang-format
<https://clang.llvm.org/docs/ClangFormat.html>`_ for C/C++ files and
`fprettify <https://github.com/fortran-lang/fprettify>`_ for Fortran files. The
``.clang-format`` file in the root of the project defines our configuration
for clang-format. We use the default fprettify settings, except we use
2-space indentation. CMake files should be formatted with
`clang-format <https://cmake-format.readthedocs.io>`_. The ``.cmake-format.py``
file in the root of the project defines our configuration for cmake-format.
<https://clang.llvm.org/docs/ClangFormat.html>`_ for C/C++, `fprettify
<https://github.com/fortran-lang/fprettify>`_ for Fortran, and `cmake-format
<https://cmake-format.readthedocs.io>`_ CMake. The ``.clang-format`` file in the
root of the project defines our configuration for clang-format. We use the
default fprettify settings, except we use 2-space indentation. The
``.cmake-format.py`` file in the root of the project defines our configuration
for cmake-format.

To apply ``clang-format``, ``fprettify``, and ``cmake-format`` you can run:

Expand Down

0 comments on commit fede229

Please sign in to comment.