Updates to satisfy pep257 violations

[radez]

What kind of change does this PR introduce?

• tests/coverage improvement

CI has a pep257 check in it that is riddled with violations.
This patch is an attempt to clean those up to help with enforcing new PRs pep257 compliance.

[radez]

There are lots more violations, Just posting this so folks can comment or help.

[webknjaz]

@radez wow, that's a lot of work! I'll have to dedicate some time to reviewing it more carefully.

Meanwhile, since you seem to have addressed all of the rule violations, could you look into removing the exclusions?

There's a pattern for temporarily excluded files in the pydocstyle entry of .pre-commit-config.yaml — if I'm right, that entire exclude thing can be just removed.
And with that, we could delete the separate .pre-commit-config-pep257.yaml config — it only existed to run an indicative check in CI on all of the files that were excluded from the check that contributes to the overall CI outcome. With the removal of exclude in the main config, all the checks will be covered by that, so the pep257 job should also be removed from the CI as well as the pre-commit invocation (the entire env) should be deleted from tox.ini.

The next step could be replacing a separate pydocstyle check with a flake8-docstrings plugin — but that has a pre-requisite of making a few updates to .pre-commit-config.yaml, including version bumps so I'd postpone it until after this PR is merged.

[webknjaz]

could you look into removing the exclusions?

Did that in 17b7f6d.

[webknjaz]

I think it'd still be nice to have actual class attribute docstrings, not just initializer args.

[radez]

I don't disagree with you, there was just enough changes to make that I didn't put the time into having actual attribute docstrings

[webknjaz]

Yeah.. It might've been easier to merge smaller PRs. I got to review a part of this yesterday, during the sprints, patching it file-by-file. But didn't get through all the files — people around needed help with other stuff they were sprinting on. I was hoping to keep going through it today.