Skip to content

Fix PEP References #656

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
freakboy3742 merged 1 commit into from
Jun 10, 2025
Merged

Fix PEP References #656

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
7 changes: 4 additions & 3 deletions content/contributing/process/contents.lr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,8 @@ Additional guidelines:
- Use InitialCaps for class names (or for factory functions that return
classes)

- Use Sphinx-style docstrings and `257`; type annotation with `484` is
- Use Sphinx-style docstrings and [PEP 257](https://peps.python.org/pep-0257/);
type annotation with [PEP 484](https://peps.python.org/pep-0484/) is
optional but encouraged.

For example:
Expand All @@ -153,8 +154,8 @@ Additional guidelines:
def test_foo():
"""A test docstring looks like this (#123456)."""

- Unless otherwise specified, follow `8` (with careful attention paid to
[Section
- Unless otherwise specified, follow [PEP 8](https://peps.python.org/pep-0008/)
(with careful attention paid to [Section
2](https://www.python.org/dev/peps/pep-0008/#a-foolish-consistency-is-the-hobgoblin-of-little-minds)).

---
Expand Down