The Pulitzer prizewinner shares his advice for pleasing readers, editors and yourself.
Black is the uncompromising Python code formatter. By using it, you agree to cede control over minutiae of hand-formatting. In return, Black gives you speed, determinism, and freedom from pycodestyle nagging about formatting. You will save time and mental energy for more important matters.
Blackened code looks the same regardless of the project you're reading. Formatting becomes transparent after a while and you can focus on the content instead.
Black makes code review faster by producing the smallest diffs possible.
Which options are preferable:
- More coffee is always better. [XY]
- More coffee is always better [XY].
- More coffee is always better[XY].
- More coffee is always better.[XY]
- According to [XY], more coffee is always better.
- According to XY[XY], more coffee is always better.
- According to XY [XY], more coffee is always better.
- According to XY, [XY] more coffee is always better.
- According to XY,[XY] more coffee is always better.
- According to XY, more coffee is always better [XY].
- According to XY, more coffee is always better. [XY]
See how a minor change to your commit message style can make you a better programmer.
Format: <type>(<scope>): <subject>
where <scope> is optional.
Example
feat: add hat wobble
^--^ ^------------^
| |
| +-> Summary in present tense.
|
+-------> Type: chore, docs, feat, fix, refactor, style, or test.More Examples:
feat: new feature for the user, not a new feature for build scriptfix: bug fix for the user, not a fix to a build scriptdocs: changes to the documentationstyle: formatting, missing semi colons, etc; no production code changerefactor: refactoring production code, eg. renaming a variabletest: adding missing tests, refactoring tests; no production code changechore: updating grunt tasks etc; no production code change
Adapted from http://www.possibility.com/Cpp/CppCodingStandard.html and NetBSD's style guidelines.