Enforce Pydocstyle

[AdrianDAlessandro]

Description

This PR enforces google style docstrings throughout the code for the ruff linter checks to pass.

I have needed to make my best-guess for describing what some of the functions and arguments are. Please confirm these make sense.

Fixes #130

Type of change

• Documentation (non-breaking change that adds or improves the documentation)
• New feature (non-breaking change which adds functionality)
• Optimization (non-breaking, back-end change that speeds up the code)
• Bug fix (non-breaking change which fixes an issue)
• Breaking change (whatever its nature)

Key checklist

• All tests pass (eg. pytest)
• The documentation builds and looks OK (eg. mkdocs)
• Pre-commit hooks run successfully (eg. pre-commit run --all-files)

Further checks

• Code is commented, particularly in hard-to-understand areas
• Tests added or an issue has been opened to tackle that in the future. (Indicate issue here: # (issue))

[alexdewar]

LGTM! Nice to see some extra type hints too.

There are some more numpy-style docstrings lurking (#139). Weird that ruff hasn't clocked them... Could tidy them up here or we can do it later.

[AdrianDAlessandro]

LGTM! Nice to see some extra type hints too.

There are some more numpy-style docstrings lurking (#139). Weird that ruff hasn't clocked them... Could tidy them up here or we can do it later.

Yea, I noticed that... I think since you already have another issue open for that, let's do it later.