Revise transformation names and add docs (#802)

* Some doc updates * Updates * Updates * More updates * Update DOLFINx tets branch * More name updates * Name updates * More updates * Stub fixes * Split out linting test * Install ruff * Actions updates * Tidy * Remove commented code * Doc improvements * Update cpp/basix/precompute.h Co-authored-by: Matthew Scroggs <[email protected]> * Doc updates * Doc updates * Small doc updates * Tidy up docs * Small doc updates --------- Co-authored-by: Matthew Scroggs <[email protected]>
FEniCS · Apr 19, 2024 · 36663d8 · 36663d8
1 parent 6099a92
commit 36663d8
Show file tree

Hide file tree

Showing 20 changed files with 857 additions and 828 deletions.
diff --git a/.github/workflows/dolfinx-tests.yml b/.github/workflows/dolfinx-tests.yml
@@ -60,7 +60,7 @@ jobs:
         with:
           path: ./dolfinx
           repository: FEniCS/dolfinx
-          ref: main
+          ref: garth/transform-names-2
       - name: Get DOLFINx
         if: github.event_name == 'workflow_dispatch'
         uses: actions/checkout@v4

diff --git a/.github/workflows/pythonapp.yml b/.github/workflows/pythonapp.yml
@@ -19,6 +19,25 @@ on:
   workflow_dispatch:
 
 jobs:
+  lint:
+    name: Lint code
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - uses: actions/checkout@v4
+      - name: Install linting dependencies
+        run: pip install mypy ruff
+      - name: Ruff check
+        run: |
+          pip install ruff
+          ruff check .
+          ruff format --check .
+      - name: Mypy check
+        run: mypy python/basix
+
   build:
     name: Build and test
     runs-on: ${{ matrix.os }}
@@ -40,12 +59,6 @@ jobs:
         run: pip -v install git+https://github.com/FEniCS/ufl.git
       - name: Install Basix
         run: pip -v install .[ci]
-      - name: Ruff check
-        run: |
-          ruff check .
-          ruff format --check .
-      - name: Run mypy checks
-        run: mypy python/basix
       - name: Run units tests
         run: pytest -n auto --durations 20 test/
       - name: Run simple CMake integration test

diff --git a/cpp/basix/dof-transformations.h b/cpp/basix/dof-transformations.h
@@ -14,13 +14,12 @@
 #include <utility>
 #include <vector>
 
-/// Functions to transform DOFs in high degree Lagrange spaces.
 ///
+/// @brief Functions to transform DOFs in high degree Lagrange spaces.
 /// The functions in this namespace calculate the permutations that can
 /// be used to rotate and reflect DOF points in Lagrange spaces.
 namespace basix::doftransforms
 {
-
 /// @brief Compute the entity DOF transformations for an element.
 ///
 /// @param[in] cell_type The cell type