Skip to content

Commit bc15649

Browse files
authored
Docs: Code prefixes for better formatting (#664)
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.
1 parent cb05145 commit bc15649

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ From PyPI
2828
From Source
2929

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

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

3939
Examples
4040
________
41-
More **examples** in **``examples/``** directory.
41+
More **examples** in :code:`examples/` directory.
4242

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

0 commit comments

Comments
 (0)