google / google/yapf

SPACES_BEFORE_COMMENT column mode violates PEP8 policy of two spaces before comment

Open
#675 0 comments 2 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
14k
Forks
904
PR merge metrics
No merged PRs in 30d

Description

Now that #667 is resolved, I have a concern about the behavior: specifying multiple values so as to use column alignment results in inline comments preceded by a single space. Shouldn't there always be two spaces as a minimum regardless of column alignment?

For example, this PEP8 compliant code:

```
else:
class args:
cgi = True # called from cgi
chase = True # Follow freeplane links to other local maps
long_url = False # Use short 'oldid' URLs for mediawikis
urls_online_only = False # Emit urls for @online only
pretty = False # Print as HTML with citation at end
query = None # Query the bibliographies
query_c = None # Query re.compiled
```

loses a space

```
else:

class args:
cgi = True # called from cgi
chase = True # Follow freeplane links to other local maps
long_url = False # Use short 'oldid' URLs for mediawikis
urls_online_only = False # Emit urls for @online only
pretty = False # Print as HTML with citation at end
query = None # Query the bibliographies
query_c = None # Query re.compiled
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.