Skip to content

Adding documentation about BLK100 issue in D.1.12, add Visual Studio dir to .gitignore #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 30, 2023
Merged

Adding documentation about BLK100 issue in D.1.12, add Visual Studio dir to .gitignore #117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,6 @@ dist/

# Can show up during `poetry install`
setup.py

# If the user uses Visual Studio
/.vs
6 changes: 3 additions & 3 deletions docs/Coding-Conventions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1149,17 +1149,17 @@ class CheeseShop(object):

> 🐍 This rule stems from [PEP 257](https://www.python.org/dev/peps/pep-0257/#multi-line-docstrings)

> 💻 This rule is enforced by error codes D201, D211
> 💻 This rule is enforced by error codes D201, D211, BLK100

```python
# Bad - will produce D211
# Bad - will produce D211, BLK100
class CheeseShop(object):

"""Finest cheese shop in the district, offering a wide variety of cheeses."""
```

```python
# Bad - will produce D201
# Bad - will produce D201, BLK100
class CheeseShop(object):
def sell(self, type_):

Expand Down