improving docstrings for object functions #44

	name: Python Package using Conda

	on: [push]

	jobs:
	build-linux:
	runs-on: ubuntu-latest
	strategy:
	max-parallel: 5
	steps:
	- uses: actions/checkout@v3
	- name: Set up Python 3.11
	uses: actions/setup-python@v3
	with:
	python-version: '3.11'
	- name: Add conda to system path
	run: \|
	# $CONDA is an environment variable pointing to the root of the miniconda directory
	echo $CONDA/bin >> $GITHUB_PATH
	- name: Install dependencies
	run: \|
	conda update conda
	conda env update --file environment.yml --name base
	- name: Lint with ruff
	run: \|
	pip install ruff
	ruff format # Format all files in the current directory (and any subdirectories).
	ruff check # Lint all files in the current directory (and any subdirectories).
	- name: Test with pytest
	run: \|
	pip install pytest pytest-cov
	NUMBA_DISABLE_JIT=1 pytest --cov
	- name: Upload results to Codecov
	uses: codecov/codecov-action@v4
	with:
	token: ${{ secrets.CODECOV_TOKEN }}

Provide feedback