From cabb921f83ef7416fb0f4d22fbad7b1b70f0e992 Mon Sep 17 00:00:00 2001 From: Adam Dangoor Date: Sat, 18 May 2024 01:11:27 +0100 Subject: [PATCH 1/2] Add project name in Contributing docs title --- docs/source/contributing.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst index 4ac46f0a6..ac3bef278 100644 --- a/docs/source/contributing.rst +++ b/docs/source/contributing.rst @@ -1,5 +1,5 @@ -Contributing -============ +Contributing to |project| +========================= Contributions to this repository must pass tests and linting. From 18ced656e0226a688f66a7e7ac21aa5594f4398d Mon Sep 17 00:00:00 2001 From: Adam Dangoor Date: Sat, 18 May 2024 01:11:33 +0100 Subject: [PATCH 2/2] Use quotes to make pip install command more cross-shell compatible --- docs/source/contributing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst index ac3bef278..444b12eb1 100644 --- a/docs/source/contributing.rst +++ b/docs/source/contributing.rst @@ -12,7 +12,7 @@ Install Python dependencies in a virtual environment. .. prompt:: bash - pip install --editable .[dev] + pip install --editable '.[dev]' Spell checking requires ``enchant``. This can be installed on macOS, for example, with `Homebrew`_: