diff --git a/docs/source/api/generation.rst b/docs/source/api/generation.rst index 36b5ca03e52dabb2301a2ff0b72f5b9624d32fbb..935e722452b2755a98bee98063de12c0cc84c54f 100644 --- a/docs/source/api/generation.rst +++ b/docs/source/api/generation.rst @@ -30,7 +30,3 @@ Categories, Parameter Types, and Special Values .. autoclass:: ClangFormatOptions :members: -Option Descriptors ------------------- - -.. autoclass:: Option diff --git a/src/pystencilssfg/config.py b/src/pystencilssfg/config.py index 3b858a5d668713e0c433b87d8f893047feade0cf..aae9dab541f95c2d7af09da46bce1346150bb4a3 100644 --- a/src/pystencilssfg/config.py +++ b/src/pystencilssfg/config.py @@ -77,9 +77,9 @@ class ClangFormatOptions(ConfigBase): """Options affecting the invocation of ``clang-format`` for automatic code formatting.""" code_style: BasicOption[str] = BasicOption("file") - """Code style to be used by clang-format. Passed verbatim to `--style` argument of the clang-format CLI. + """Code style to be used by clang-format. Passed verbatim to ``--style`` argument of the clang-format CLI. - Similar to clang-format itself, the default value is `file`, such that a `.clang-format` file found in the build + Similar to clang-format itself, the default value is ``file``, such that a ``.clang-format`` file found in the build tree will automatically be used. """