From f5088e7bbdf3ebbabc6ea8c8cd4cb6b2ee29e9a7 Mon Sep 17 00:00:00 2001 From: Andrei Lapets Date: Sun, 29 Sep 2024 17:22:44 -0400 Subject: [PATCH] Add quotes to commands in README to improve compatibility with different shells. --- README.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index a784281..c4ab98a 100644 --- a/README.rst +++ b/README.rst @@ -184,7 +184,7 @@ All installation and development dependencies are fully specified in ``pyproject .. code-block:: bash - python -m pip install .[docs,lint] + python -m pip install ".[docs,lint]" Documentation ^^^^^^^^^^^^^ @@ -192,7 +192,7 @@ The documentation can be generated automatically from the source files using `Sp .. code-block:: bash - python -m pip install .[docs] + python -m pip install ".[docs]" cd docs sphinx-apidoc -f -E --templatedir=_templates -o _source .. && make html @@ -202,7 +202,7 @@ All unit tests are executed and their coverage is measured when using `pytest `__: @@ -215,7 +215,7 @@ Style conventions are enforced using `Pylint `__: .. code-block:: bash - python -m pip install .[lint] + python -m pip install ".[lint]" python -m pylint src/blooms test/test_blooms.py Contributions @@ -232,7 +232,7 @@ This library can be published as a `package on PyPI `__ that activates and sets as the default all tagged versions. -To publish the package, create and push a tag for this version (replacing ``?.?.?`` with the version number): +To publish the package, create and push a tag for the version being published (replacing ``?.?.?`` with the version number): .. code-block:: bash