From 2f80a5162daeac7f68da75b03ca5d850db9e4304 Mon Sep 17 00:00:00 2001 From: partev Date: Sat, 4 Feb 2023 16:30:12 -0500 Subject: [PATCH] DOC: fix a typo "docstring" -> "docstrings" when using the "docstring" parameter I get an error: $ ./ci/code_checks.sh docstring Unknown command docstring. Usage: ./ci/code_checks.sh [code|doctests|docstrings|single-docs|notebooks] --- doc/source/development/contributing_codebase.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/development/contributing_codebase.rst b/doc/source/development/contributing_codebase.rst index b619523b16eef..63554447f295e 100644 --- a/doc/source/development/contributing_codebase.rst +++ b/doc/source/development/contributing_codebase.rst @@ -25,7 +25,7 @@ contributing them to the project:: The script validates the doctests, formatting in docstrings, and imported modules. It is possible to run the checks independently by using the -parameters ``docstring``, ``code``, and ``doctests`` +parameters ``docstrings``, ``code``, and ``doctests`` (e.g. ``./ci/code_checks.sh doctests``). In addition, because a lot of people use our library, it is important that we