update docs and code to match new rule (#51) #36

	name: Test

	on:
	push:
	branches:
	- main
	pull_request:
	branches:
	- main

	concurrency:
	group: ${{ github.workflow }}-${{ github.head_ref \|\| github.run_id }}
	cancel-in-progress: true

	jobs:
	test:
	if: github.event_name == 'pull_request'
	runs-on: ${{ matrix.os }}
	defaults:
	run:
	shell: bash
	steps:
	- name: Checkout source code
	uses: actions/checkout@v4
	- name: Set up python
	id: setup-python
	uses: actions/setup-python@v5
	with:
	python-version: ${{ matrix.python-version }}
	- name: Install Poetry
	uses: snok/install-poetry@v1.4.1
	with:
	virtualenvs-in-project: true
	- name: Load cached venv
	id: cached-poetry-dependencies
	uses: actions/cache@v4
	with:
	path: .venv
	key: venv-test-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
	- name: Install dependencies
	if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
	run: poetry install --no-interaction --no-root
	- name: Activate virtual environment
	run: source $VENV
	- name: Test with pytest
	run: poetry run poe test --cov-report=xml
	- name: Upload coverage reports to Codecov
	uses: codecov/codecov-action@v4
	with:
	fail_ci_if_error: true
	token: ${{ secrets.CODECOV_TOKEN }}
	verbose: true
	strategy:
	fail-fast: false
	matrix:
	python-version: ["3.11", "3.12"]
	os: [ubuntu-latest, macos-latest, windows-latest]

Provide feedback