Skip to content

Conversation

mwhahaha
Copy link
Contributor

@mwhahaha mwhahaha commented Nov 5, 2020

This change documents the usage of black as the prefered formatter for
this project. Additionally it adds two tox targets that can be used to
have black be invoked.

  • tox -e black will print out what would be changed
  • tox -e black-format will actually update the files with the code
    formatted

Black is configured via pyproject.toml with a line-length of 100 and
will skip string normalization

Closes #28

Signed-off-by: Alex Schultz aschultz@redhat.com

@mwhahaha
Copy link
Contributor Author

mwhahaha commented Nov 5, 2020

Should hold off on this until #38 lands, then it'll just be a tox env and documentation

## Testing
Depending on the size of your PR we will expect at a minimum unit tests.

Depending on the size of your PR we will expect at a minimum unit tests.
Copy link
Member

Choose a reason for hiding this comment

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

@mwhahaha Thanks for this work.

Given your coverage work and we're in the high 80's on coverage. How about putting a number on the unit test/coverage results? Won't merge if PR coverage falls below 85%?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure we can raise that and document it

This change documents the usage of black as the prefered formatter for
this project. Additionally it adds two tox targets that can be used to
have black be invoked.

* `tox -e black` will print out what would be changed
* `tox -e black-format` will actually update the files with the code
  formatted

Black is configured via pyproject.toml with a line-length of 100 and
will skip string normalization

Closes containers#28

Signed-off-by: Alex Schultz <aschultz@redhat.com>
@rhatdan
Copy link
Member

rhatdan commented Nov 7, 2020

LGTM

@rhatdan rhatdan merged commit 5c63eb8 into containers:master Nov 7, 2020
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.

PEP8 style guide

3 participants