add some more docstrings #232

	name: PR Checks
	on:
	push:
	branches: [main, stable]
	pull_request:
	branches: [main, stable]
	workflow_dispatch:
	jobs:
	unit_tests:
	name: Unit Tests
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	- uses: ./.github/actions/setup-bfabricpy
	with:
	python-version: 3.9
	- name: Run unit tests
	# Note: we use cd to double-check that the installation actually worked
	run: cd bfabric/tests && pytest ./unit
	code_style:
	name: Code Style
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	- uses: ./.github/actions/setup-bfabricpy
	with:
	python-version: 3.9
	- name: Check code with ruff
	run: ruff bfabric \|\| true
	list_todos:
	name: List TODOs
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	- run: sudo apt-get install -y ripgrep
	name: Install ripgrep
	- run: rg -n TODO bfabric
	name: List TODOs
	license_check:
	name: License Check
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	- uses: ./.github/actions/setup-bfabricpy
	with:
	python-version: 3.9
	- name: Check licenses
	run: licensecheck

Provide feedback