diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 125d7d8f..fb51913b 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -11,7 +11,7 @@ repos: - id: requirements-txt-fixer - id: trailing-whitespace - repo: https://github.com/pre-commit/mirrors-clang-format - rev: "v15.0.6" + rev: "v19.1.7" hooks: - id: clang-format types_or: [c++] diff --git a/docs/developer_documentation/SPECFEM_architecture/architecture.rst b/docs/developer_documentation/SPECFEM_architecture/architecture.rst index 834d1321..9d4cc4fa 100644 --- a/docs/developer_documentation/SPECFEM_architecture/architecture.rst +++ b/docs/developer_documentation/SPECFEM_architecture/architecture.rst @@ -1,7 +1,7 @@ .. _architecture: SPECFEM++ Architecture -==================== +====================== SPECFEM++ is designed with portability and modularity as primary goals. The goal is develop a code that is easy to maintain and extend, while maintaining performance characteristics of original `SPECFEM2D solver `_. This is achieved using C++ templatized classes. diff --git a/docs/developer_documentation/git_workflow.rst b/docs/developer_documentation/git_workflow.rst index 9dab12b9..de0b6634 100644 --- a/docs/developer_documentation/git_workflow.rst +++ b/docs/developer_documentation/git_workflow.rst @@ -1,5 +1,5 @@ Git development workflow -========================= +======================== At SPECFEM++ we follow master-develop workflow. The master (main) branch is always a stable working code and is generally synced with the latest release of SPECFEM++. The develop branch is a stable code with potentially new features which haven't been released in the latest version of SPECFEM++ yet. If you are contributing to SPECFEM++ then issue your `pull request `_ against the develop branch. @@ -15,11 +15,11 @@ To make a change to SPECFEM++ (This development workflow is similar to the one s .. note:: - It is also recommended that you run :code:`poetry install` every time you pull the develop branch. Please check :ref:`style section