Skip to content

Commit

Permalink
Docs: Code prefixes for better formatting (#664)
Browse files Browse the repository at this point in the history
Readme file contained several inline code sequences. They were marked
with ``. They have no text role, so they are not formatted as code on
GitHub. Text role :code: is now used to format the inline code. It
better highlights the code sections.
  • Loading branch information
jensvog authored Dec 29, 2020
1 parent cb05145 commit bc15649
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ From PyPI
From Source

- Git clone repository
- Use `pip install -r requirements.txt` to install the required packages
- or `pipenv install && pipenv install --dev`
- Use :code:`pip install -r requirements.txt` to install the required packages
- or :code:`pipenv install && pipenv install --dev`

How to contribute?
__________________
Expand All @@ -38,7 +38,7 @@ Please, click here `Contribution Guidelines for this project`_

Examples
________
More **examples** in **``examples/``** directory.
More **examples** in :code:`examples/` directory.

Here's a short example of how to create a Confluence page:

Expand Down

0 comments on commit bc15649

Please sign in to comment.