diff --git a/.github/workflows/docstrings.yml b/.github/workflows/docstrings.yml new file mode 100644 index 00000000..df48230d --- /dev/null +++ b/.github/workflows/docstrings.yml @@ -0,0 +1,19 @@ +name: Docstrings +on: + pull_request: + push: + branches: + - main +concurrency: + group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} + cancel-in-progress: true + +jobs: + docstrings: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v5 + - uses: chartboost/ruff-action@v1 + with: + args: check --select="D" + src: src/ diff --git a/pyproject.toml b/pyproject.toml index 9018d4e8..902effad 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -116,6 +116,9 @@ dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$" [tool.coverage.run] include = ["src/bloqade/*"] +[tool.ruff.lint.pydocstyle] +convention = "google" + [tool.pytest.ini_options] testpaths = "test/" filterwarnings = [