Skip to content

Commit

Permalink
Updates to dev docs (#9780)
Browse files Browse the repository at this point in the history
- Stop talking about black
- Use type annotations in examples
  • Loading branch information
alex authored Oct 26, 2023
1 parent 8dd3f6c commit 1cb847a
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/development/submitting-patches.rst
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

0 comments on commit 1cb847a

Please sign in to comment.