fix: docstrings

[jakelorocco]

Fixes docstrings for mellea/; doesn't fix for cli/ and docs/

I re-enabled the docstring rules for the ruff linter. It isn't as strict in many ways. I also checked for additional arguments (args that were in the docstring but not the function) using pydoclint.

pydoclint reports a lot of additional issues (like a lack of types, etc...). Unfortunately, it doesn't look like there's tools to add type hints to already existing docstrings.

We should define how strict we want to be going forward and see if ruff can enforce that. If not, it might be worth having an additional pydoclint check:

• all docstrings require args and return sections
• all docstrings require type hints
• either the class or init method should have a docstring, not both (for some reason ruff forces both to have docstrings)
• docstrings must have raises sections
• etc...

[mergify]

Merge Protections

Your pull request matches the following merge protections and will not be merged until they are valid.

🟢 Enforce conventional commit

Wonderful, this rule succeeded.

Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/

• title ~= ^(fix|feat|docs|style|refactor|perf|test|build|ci|chore|revert|release)(?:\(.+\))?:

[HendrikStrobelt]

approved via slack