Skip to content

Commit

Permalink
Merge pull request #11 from adamtheturtle/shell
Browse files Browse the repository at this point in the history
Use code-block as code isn't picked up by Sybil
  • Loading branch information
adamtheturtle authored Sep 11, 2024
2 parents dfb0334 + 93c87e4 commit 9feefb0
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ With `pip`

Requires Python 3.11+.

.. code:: sh
.. code-block:: shell
pip install doccmd
Expand All @@ -25,7 +25,7 @@ With Homebrew (macOS, Linux, WSL)

Requires `Homebrew`_.

.. code:: sh
.. code-block:: shell
brew tap adamtheturtle/doccmd
brew install doccmd
Expand All @@ -35,10 +35,10 @@ Requires `Homebrew`_.
Usage example
-------------

.. code:: sh
.. code-block:: shell
# Run mypy against the Python code blocks in README.md and CHANGELOG.rst
$ doccmd --language=python --command="mypy README.md CHANGELOG.rst
$ doccmd --language=python --command="mypy" README.md CHANGELOG.rst
# Run gofmt against the Go code blocks in README.md
# This will modify the README.md file in place
Expand Down

0 comments on commit 9feefb0

Please sign in to comment.