Add docstring checks to pre-commit script

[strickvl]

I added a pre-commit check that ensures all methods contain correct docstrings as per our formatting and that arguments in the method/function signatures match what are specified in the docstring.

I implemented several modules to start with as you can see in the files, but merging develop added in a bunch more failing code so you'll see that the darglint / pydocstyle checks are only running for two modules. I will add smaller scoped PRs over the coming weeks to cover the rest.

The docstring checks now run as part of the lint script, but I added a separate docstring.sh script for the purpose of working on the specific task of fixing docstrings (so that you don't have to also run things like mypy that take extra time).

I'll also circulate a Notion document so that the implications / decisions around this will be clear.

Pre-requisites

Please ensure you have done the following:

• I have read the CONTRIBUTING.md document.
• If my change requires a change to docs, I have updated the documentation accordingly.
• If I have added an integration, I have updated the integrations table.
• I have added tests to cover my changes.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Other (add details above)

[htahir1]

Cool. But if we are using this tool, we need a way to use it outside of just the pre-commit. We need it in the GitHub actions via a scripts/docstrings-check.sh or something. We can then also use that script locally without pre-commit. That means we need to add it to the pyproject.toml. So its a bit more work :-)

[strickvl]

@htahir1 Yes I'll add it to the script as well. This was very much a draft PR for the moment. Our codebase has hundreds of methods that need fixing, so I'll work on this slowly on the side as it's not such a high-priority thing needing an immediate fix.