Skip to content

Commit

Permalink
Add quotes to commands in README to improve compatibility with differ…
Browse files Browse the repository at this point in the history
…ent shells.
  • Loading branch information
lapets committed Sep 29, 2024
1 parent 2a22595 commit f5088e7
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -184,15 +184,15 @@ 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
^^^^^^^^^^^^^
The documentation can be generated automatically from the source files using `Sphinx <https://www.sphinx-doc.org>`__:

.. 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
Expand All @@ -202,7 +202,7 @@ All unit tests are executed and their coverage is measured when using `pytest <h

.. code-block:: bash
python -m pip install .[test]
python -m pip install ".[test]"
python -m pytest
The subset of the unit tests included in the module itself and can be executed using `doctest <https://docs.python.org/3/library/doctest.html>`__:
Expand All @@ -215,7 +215,7 @@ Style conventions are enforced using `Pylint <https://pylint.readthedocs.io>`__:

.. code-block:: bash
python -m pip install .[lint]
python -m pip install ".[lint]"
python -m pylint src/blooms test/test_blooms.py
Contributions
Expand All @@ -232,7 +232,7 @@ This library can be published as a `package on PyPI <https://pypi.org/project/bl

Ensure that the correct version number appears in ``pyproject.toml``, and that any links in this README document to the Read the Docs documentation of this package (or its dependencies) have appropriate version numbers. Also ensure that the Read the Docs project for this library has an `automation rule <https://docs.readthedocs.io/en/stable/automation-rules.html>`__ 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
Expand Down

0 comments on commit f5088e7

Please sign in to comment.