docs: cleaned up docstrings #6
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: code-quality | |
| on: [push, pull_request] | |
| jobs: | |
| pre-commit: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: astral-sh/setup-uv@v6 | |
| - uses: actions/cache@v4 | |
| with: | |
| path: ~/.cache/uv | |
| key: uv-${{ hashFiles('pyproject.toml') }} | |
| - name: Initialise pre-commit | |
| run: uv run pre-commit install-hooks | |
| - name: Run pre-commit hooks | |
| run: uv run pre-commit run --all-files | |
| test: | |
| runs-on: ubuntu-latest | |
| needs: pre-commit | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: astral-sh/setup-uv@v6 | |
| - uses: actions/cache@v4 | |
| with: | |
| path: ~/.cache/uv | |
| key: uv-${{ hashFiles('pyproject.toml') }} | |
| - name: Run tests | |
| run: uv run pytest . | |
| build: | |
| runs-on: ubuntu-latest | |
| needs: [pre-commit, test] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: astral-sh/setup-uv@v6 | |
| - uses: actions/cache@v4 | |
| with: | |
| path: ~/.cache/uv | |
| key: uv-${{ hashFiles('pyproject.toml') }} | |
| - name: Build package | |
| run: uv build |