From f1849ffbb7e81dce941a7b93e646834294d2c6fe Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Wed, 25 Oct 2023 20:39:09 -0400 Subject: [PATCH] Updates to dev docs - Stop talking about black - Use type annotations in examples --- docs/development/submitting-patches.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/development/submitting-patches.rst b/docs/development/submitting-patches.rst index 6148419ce134..147de318e40f 100644 --- a/docs/development/submitting-patches.rst +++ b/docs/development/submitting-patches.rst @@ -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.`_ @@ -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