From 13e5ef010250ae98b8b2aa76952d447274d20e25 Mon Sep 17 00:00:00 2001 From: neilmartin2000 <143754352+neilmartin2000@users.noreply.github.com> Date: Fri, 3 Nov 2023 12:05:05 -0600 Subject: [PATCH] Created link to PEP-8 in documentation (#11582) --- AUTHORS | 1 + CONTRIBUTING.rst | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/AUTHORS b/AUTHORS index 5ccff644c..212d4a883 100644 --- a/AUTHORS +++ b/AUTHORS @@ -275,6 +275,7 @@ Miro HronĨok Nathaniel Compton Nathaniel Waisbrot Ned Batchelder +Neil Martin Neven Mundar Nicholas Devenish Nicholas Murphy diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index e2230cbbd..6f55c230c 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -199,7 +199,7 @@ Short version #. Fork the repository. #. Fetch tags from upstream if necessary (if you cloned only main `git fetch --tags https://github.com/pytest-dev/pytest`). #. Enable and install `pre-commit `_ to ensure style-guides and code checks are followed. -#. Follow **PEP-8** for naming and `black `_ for formatting. +#. Follow `PEP-8 `_ for naming. #. Tests are run using ``tox``:: tox -e linting,py39 @@ -282,7 +282,7 @@ Here is a simple overview, with pytest-specific bits: This command will run tests via the "tox" tool against Python 3.9 and also perform "lint" coding-style checks. -#. You can now edit your local working copy and run the tests again as necessary. Please follow PEP-8 for naming. +#. You can now edit your local working copy and run the tests again as necessary. Please follow `PEP-8 `_ for naming. You can pass different options to ``tox``. For example, to run tests on Python 3.9 and pass options to pytest (e.g. enter pdb on failure) to pytest you can do::