Improve code formatting in README

globality-corp / flake8-logging-format

Flake8 extension to validate (lack of) logging format strings

Apache License 2.0

134 stars 21 forks source link

Improve code formatting in README #16

Closed keimlink closed 5 years ago

keimlink commented 5 years ago

Use fenced code blocks with language identifier to enable syntax highlighting.

Add import and logger definitions to allow coping of examples without errors.

Add missing quotes to "Earth" in format() example.

Replace dict() with literal in extra example. It's recommended to use the literal if possible.

Format all code using Black.

jessemyers commented 5 years ago

I don't love this contribution.

I have no problem with the import or quotation changes because they solve a specific problem -- enabling the examples to be copied and run as-is.

The other changes, however, do not solve a problem; they propose an alternate style, which doesn't happen to be the style chosen by this project so far.

As a reviewer, I'd much rather be presented with these changes separately.