Skip to content
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

Updates to dev docs #9780

Merged
merged 1 commit into from
Oct 26, 2023
Merged

Updates to dev docs #9780

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
12 changes: 6 additions & 6 deletions docs/development/submitting-patches.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ Code
----

When in doubt, refer to :pep:`8` for Python code. You can check if your code
meets our automated requirements by formatting it with ``black`` and running
``ruff`` against it. If you've installed the development requirements this
will automatically use our configuration. You can also run the ``nox`` job with
``nox -e flake``.
meets our automated requirements by formatting it with ``ruff format`` and
running ``ruff`` against it. If you've installed the development requirements
this will automatically use our configuration. You can also run the ``nox``
job with ``nox -e flake``.

`Write comments as complete sentences.`_

Expand Down Expand Up @@ -61,12 +61,12 @@ whether the signature was valid.
.. code-block:: python

# This is bad.
def verify(sig):
def verify(sig: bytes) -> bool:
# ...
return is_valid

# Good!
def verify(sig):
def verify(sig: bytes) -> None:
# ...
if not is_valid:
raise InvalidSignature
Expand Down