Skip to content

Commit 5ad6421

Browse files
committed
test use of html tags for code blocks
1 parent 9a4c24b commit 5ad6421

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

docs/pages/usage.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,10 @@ It offers functionalities to download datasets, load them into Python environmen
1313

1414
## Installation
1515
`coderdata` requires `python>=3.9` to be installed. The installed version can be checked via
16-
```shell
17-
$ python --version
18-
Python 3.13.1
16+
<div class="code-block">
17+
<p>$ python --version</p>
18+
<p>Python 3.13.1</p>
19+
</div>
1920
```
2021
If a Python version older that 3.9 is installed please referr to the instruction at [python.org](https://www.python.org/about/gettingstarted/#installing) on how to install / update Python.
2122
@@ -36,19 +37,20 @@ The primary way to interact with coderdata is through the `coderdata` API. Addit
3637

3738
### CLI
3839
Invoking `coderdata` from the command line will by default print a help / usage message and exit (see below):
39-
```sh
40-
$ coderdata
41-
usage: coderdata [-h] [-l | -v] {download} ...
40+
<div class="code-block">
41+
<p>$ coderdata</p>
42+
<p>usage: coderdata [-h] [-l | -v] {download} ...</p>
43+
<p></p>
44+
<p>options:</p>
45+
<p> -h, --help show this help message and exit</p>
46+
<p> -l, --list prints list of available datasets and exits program.</p>
47+
<p> -v, --version prints the versions of the coderdata API and dataset and exits the program</p>
48+
<p></p>
49+
<p>commands:</p>
50+
<p> {download}</p>
51+
<p> download subroutine to download datasets. See "coderdata download -h" for more options.</p>
52+
</div>
4253

43-
options:
44-
-h, --help show this help message and exit
45-
-l, --list prints list of available datasets and exits program.
46-
-v, --version prints the versions of the coderdata API and dataset and exits the program
47-
48-
commands:
49-
{download}
50-
download subroutine to download datasets. See "coderdata download -h" for more options.
51-
```
5254

5355
The primary use case of the CLI is to retrieve dataset from the repository. This can be done by invoking the `download` routine of `coderdata`. Without defining a specific dataset the whole repository will be downloaded:
5456
```sh

0 commit comments

Comments
 (0)