Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
33 changes: 2 additions & 31 deletions docs/Coding-Conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -1145,37 +1145,8 @@ class CheeseShop(object):

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

### [D.1.12] ❌ **DO NOT** Put a blank line before a docstring 💻

> 🐍 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, BLK100

```python
# 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, BLK100
class CheeseShop(object):
def sell(self, type_):

"""Sells the specified type of cheese."""
```

```python
# Good
class CheeseShop(object):
"""Finest cheese shop in the district, offering a wide variety of cheeses."""

def sell(self, type_):
"""Sells the specified type of cheese."""
```

### [D.1.13] ❌ **DO NOT** Put a blank line after a one line function docstring 💻
### [D.1.12] ❌ **DO NOT** Put a blank line after a one line function docstring 💻

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

Expand All @@ -1197,7 +1168,7 @@ def sell(self, type_):
```


### [D.1.14] ❌ **DO NOT** Put a blank line after section headers 💻
### [D.1.13] ❌ **DO NOT** Put a blank line after section headers 💻

> 💻 This rule is enforced by error code D412

Expand Down
84 changes: 42 additions & 42 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ python = "^3.7"

# Tools we aggregate
flake8 = "^5.0"
black = ">=22.3, !=22.10.0" # https://github.com/psf/black/issues/3312
black = ">=23.1"

# Additional support libraries
# These dependencies were selected because they are already used by black.
Expand Down