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

update black version #119

Merged
merged 3 commits into from
Jun 19, 2024

Conversation

phlogistonjohn
Copy link
Collaborator

Depends on: #118

Add some docstrings and then update the version of the black formatter tool our tox envs are allowed to use.

Copy link

dpulls bot commented Jun 18, 2024

🎉 All dependencies have been resolved !

Copy link

mergify bot commented Jun 18, 2024

This pull request now has conflicts with the target branch. Please resolve these conflicts and force push the updated branch.

Add docststrings to various protocol types. Some are a bit vague as
these are protocols not concrete types.

Signed-off-by: John Mulligan <[email protected]>
Add docststrings to various protocol types. Some are a bit vague as
these are protocols not concrete types.

Signed-off-by: John Mulligan <[email protected]>
Allow tox to use a version of the black tool from 2024.  Having added
doc strings to protocols the black tool, using the 2024 style,  will no
longer rewrite long-ish protocol method definitions that will span
multiple lines either way from:

    def foo(a: str, b: str, c: SomethingCompletelyDifferent) -> int:
        ...

to

    def foo(
        a: str, b: str, c: SomethingCompletelyDifferent
    ) -> int: ...

Just to force the ellipsis to be on the "same line" as the definition.
This is change I find a bit unnecessary and a tad bit ugly.  I did
report this to the black team but they chose to make the change anyway.

So they've unintentionally caused me to write more doc strings. Which is
a good thing I guess. :-)

Signed-off-by: John Mulligan <[email protected]>
@phlogistonjohn
Copy link
Collaborator Author

cc: @avanthakkar - for an additional review & peek into this code base

Copy link
Collaborator

@anoopcs9 anoopcs9 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm.

Copy link
Collaborator

@synarete synarete left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@mergify mergify bot merged commit c0b1582 into samba-in-kubernetes:master Jun 19, 2024
9 checks passed
@phlogistonjohn phlogistonjohn deleted the jjm-black-version branch June 20, 2024 13:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants