Make formatting consistent

Author: wesselb

.github/workflows/ci.yml

@@ -59,7 +59,7 @@ jobs:
           parallel: true
           file: coverage.lcov
 
-  # Test that mypyc-compiled wheels work
+  # Test that `mypyc`-compiled wheels work.
   test-mypyc:
     name: Test mypyc wheel
     runs-on: ubuntu-latest

.github/workflows/codeql.yml

@@ -1,4 +1,4 @@
-name: "CodeQL Advanced"
+name: CodeQL Advanced
 
 on:
   push:
@@ -15,16 +15,17 @@ jobs:
     #   - https://gh.io/recommended-hardware-resources-for-running-codeql
     #   - https://gh.io/supported-runners-and-hardware-resources
     #   - https://gh.io/using-larger-runners (GitHub.com only)
-    # Consider using larger runners or machines with greater resources for possible analysis time improvements.
+    # Consider using larger runners or machines with greater resources for possible
+    # analysis time improvements.
     runs-on: ubuntu-latest
     permissions:
-      # required for all workflows
+      # Required for all workflows:
       security-events: write
 
-      # required to fetch internal or private CodeQL packs
+      # Required to fetch internal or private CodeQL packs:
       packages: read
 
-      # only required for workflows in private repositories
+      # Only required for workflows in private repositories:
       actions: read
       contents: read
 
@@ -36,49 +37,25 @@ jobs:
           build-mode: none
         - language: python
           build-mode: none
-        # CodeQL supports the following values keywords for 'language': 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'rust', 'swift'
-        # Use `c-cpp` to analyze code written in C, C++ or both
-        # Use 'java-kotlin' to analyze code written in Java, Kotlin or both
-        # Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
-        # To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
-        # see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
-        # If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
-        # your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
     steps:
     - name: Checkout repository
       uses: actions/checkout@v4
 
-    # Add any setup steps before running the `github/codeql-action/init` action.
-    # This includes steps like installing compilers or runtimes (`actions/setup-node`
-    # or others). This is typically only required for manual builds.
-    # - name: Setup runtime (example)
-    #   uses: actions/setup-example@v1
-
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
       uses: github/codeql-action/init@v4
       with:
         languages: ${{ matrix.language }}
         build-mode: ${{ matrix.build-mode }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-
-        # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
-        # queries: security-extended,security-and-quality
 
-    # If the analyze step fails for one of the languages you are analyzing with
-    # "We were unable to automatically build your code", modify the matrix above
-    # to set the build mode to "manual" for that language. Then modify this step
-    # to build your code.
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+    # See https://docs.github.com/en/enterprise-server@3.16/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/codeql-code-scanning-for-compiled-languages#using-multiple-build-modes-in-a-multi-language-repository
     - name: Run manual build steps
+
       if: matrix.build-mode == 'manual'
       shell: bash
       run: |
-        echo 'If you are using a "manual" build mode for one or more of the' \
-          'languages you are analyzing, replace this with the commands to build' \
+        echo 'If you are using a "manual" build mode for one or more of the ' \
+          'languages you are analyzing, replace this with the commands to build ' \
           'your code, for example:'
         echo '  make bootstrap'
         echo '  make release'

.github/workflows/publish.yml

@@ -11,13 +11,13 @@ on:
                 default: false
                 type: boolean
 
-# Cancel any in-progress build when a new commit is pushed
+# Cancel any in-progress build when a new commit is pushed.
 concurrency:
     group: ${{ github.workflow }}-${{ github.ref }}
     cancel-in-progress: true
 
 jobs:
-    # Build the sdist and pure Python wheel
+    # Build the `sdist` and pure Python wheel.
     sdist-and-wheel:
         name: Build sdist and pure wheel
         runs-on: ubuntu-latest
@@ -46,7 +46,7 @@ jobs:
                   name: wheel-pure
                   path: dist/*.whl
 
-    # Generate the wheel build matrix dynamically
+    # Generate the wheel build matrix dynamically.
     generate-wheels-matrix:
         name: Generate wheels matrix
         runs-on: ubuntu-latest
@@ -70,7 +70,7 @@ jobs:
                 MATRIX=$(jq -sc '.' /tmp/*_builds.json | jq -c '.')
                 echo "include=$MATRIX" >> "$GITHUB_OUTPUT"
 
-    # Build mypyc-compiled wheels using cibuildwheel
+    # Build `mypyc`-compiled wheels using `cibuildwheel`.
     mypyc-wheels:
         name: Build ${{ matrix.only }}
         needs: generate-wheels-matrix
@@ -97,12 +97,12 @@ jobs:
                   name: wheel-${{ matrix.only }}
                   path: wheelhouse/*.whl
 
-    # Publish to PyPI using trusted publishing
+    # Publish to PyPI using trusted publishing.
     publish:
         name: Publish to PyPI
         needs: [sdist-and-wheel, mypyc-wheels]
         runs-on: ubuntu-latest
-        # Only publish on release events or manual trigger with publish=true
+        # Only publish on release events or manual trigger with `publish=true`.
         if: github.event_name == 'release' || (github.event_name == 'workflow_dispatch' && inputs.publish)
         environment:
             name: pypi

src/plum/__init__.py

@@ -109,7 +109,7 @@
 )
 from ._version import __version__  # noqa: F401  # noqa: F401
 
-# If mypyc compiled, one of the core modules will be a native extension
+# If `mypyc`-compiled, one of the core modules will be a native extension.
 spec = importlib.util.find_spec("plum._bear")
 COMPILED = (
     spec is not None