Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare isort black formatters and checks #766

Merged

Conversation

bpkroth
Copy link
Contributor

@bpkroth bpkroth commented Jun 28, 2024

Builds off of #762, #763, and #764.

Prepares rules and configs to enable isort and black formatters and checks but doesn't enable them yet.

After these are enabled (next PR) we will reformat all files and ignore that revision in git blame configs.

Then, we can convert configs stored in setup.cfg and .pylintrc to the top level pyproject.toml and remove the older configs.

@bpkroth bpkroth marked this pull request as ready for review July 3, 2024 17:27
@bpkroth bpkroth requested a review from a team as a code owner July 3, 2024 17:27
@bpkroth bpkroth merged commit cef476c into microsoft:main Jul 3, 2024
11 of 12 checks passed
@bpkroth bpkroth deleted the prepare-isort-black-formatters-and-checks branch July 3, 2024 20:57
bpkroth added a commit that referenced this pull request Jul 12, 2024
Follow on work to #766.

This enabled both formatters and applies their changes to the repo.

Additionally, since `black` does not make changes to comments nor
docstrings, we also enable `docformatter` to reformat docstrings which
better aligns with `pydocstyle` rules as well.
Without this additional change (and some manual fixups), `pycodestyle`
and `pylint` would still complain about line lengths, for instance.

Finally, we make a minor adjustment to the max line length setting it to
99 (which is also accepted and mentioned in pep8) instead of 88 to avoid
some comment (especially linter overrides) wrapping.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants