Test

docs: update docstring and apply linter suggestions #13

	# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
	# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python

	name: Test

	on:
	push:
	branches: [ "main" ]
	pull_request:
	branches: [ "main" ]
	workflow_dispatch:

	jobs:
	build:

	runs-on: ubuntu-latest
	strategy:
	fail-fast: false
	matrix:
	python-version: ["3.11", "3.12"]

	steps:
	- uses: actions/checkout@v4
	- name: Set up Python ${{ matrix.python-version }}
	uses: actions/setup-python@v5
	with:
	python-version: ${{ matrix.python-version }}
	- name: Install dependencies
	run: \|
	sudo apt update && sudo apt install -y libegl1-mesa-dev
	python -m pip install --upgrade pip
	python -m pip install -v . flake8 pytest
	# pip install -r requirements.txt
	- name: Lint with flake8
	run: \|
	# stop the build if there are Python syntax errors or undefined names
	flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
	# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
	flake8 . --count --extend-ignore=E203,F401 --exit-zero --max-line-length=88 --statistics --exclude _deprecated
	- name: Test with pytest
	run: \|
	pytest

Provide feedback