Skip to content

README Ambiguous: "strict subset of PEP 8" #1272

@p0llard

Description

@p0llard

Description

The README states:

The coding style used by Black can be viewed as a strict subset of PEP 8.

I believe this can be interpreted in one of two ways:

  1. The rules enforced by Black are a strict subset of the PEP 8 rules.
  2. The set of Black compliant programs is a strict subset of PEP 8 compliant programs.

As a new user of Black I have been unable to work out the intention here; a cursory Google yields this article which states:

Black’s formatting rules are a superset of PEP 8. If you choose to use Black, you get PEP 8 compliance for free [...]

This would imply that 2. is the correct interpretation.

However from my experiments, it seems that Black doesn't enforce PEP 8 import ordering/grouping, which would imply 1. is the case.

Whilst this is arguable not very important, I think the current documentation is unclear and should be changed.

Metadata

Metadata

Assignees

No one assigned

    Labels

    T: documentationImprovements to the docs (e.g. new topic, correction, etc)

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions