Add more code style rules

[melanieclarke]

Currently, in CI, the jwst repo uses a ruff check with default rules selected. This misses some basic PEP8 compliance issues, like trailing whitespaces and very long lines.

For basic checks, we should probably at least include lint.select = ["E", "F", "W"]. Looking at the current state of the repository, it should be pretty easy to come up to compliance with this rule set.

To clean up our documentation, it would probably also help to select the "D" rules for documentation style, with some exceptions for things like unit tests. This looks like it will be a bit more work to come up to compliance with, but it would likely help save code review steps in the future.

We could consider also including the "N" rules, for Python naming consistency, but this also looks like it would take some work with the current repository state, and would be a riskier refactor than updating the docstrings.

It would also be nice to include a formatter in CI, like black or ruff format, for more consistent style and readability.

[melanieclarke]

@stscijgbot-jp

[nden]

@stscijgbot-jp

[stscijgbot-jp]

This issue is tracked on JIRA as JP-3769.

[braingram]

xref: #8648