Skip to content

Commit cefd296

Browse files
author
Corentin
committed
correct uppercase in tool doc
1 parent d20be4c commit cefd296

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

CLI_Documentation.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# `MyoQuant`
1+
# `myoquant`
22

33
MyoQuant Analysis Command Line Interface
44

55
**Usage**:
66

77
```console
8-
$ MyoQuant [OPTIONS] COMMAND [ARGS]...
8+
$ myoquant [OPTIONS] COMMAND [ARGS]...
99
```
1010

1111
**Options**:
@@ -18,14 +18,14 @@ $ MyoQuant [OPTIONS] COMMAND [ARGS]...
1818
* `he-analysis`: Run the HE analysis and quantification on...
1919
* `sdh-analysis`: Run the SDH analysis and quantification on...
2020

21-
## `MyoQuant docs`
21+
## `myoquant docs`
2222

2323
Generate documentation
2424

2525
**Usage**:
2626

2727
```console
28-
$ MyoQuant docs [OPTIONS] COMMAND [ARGS]...
28+
$ myoquant docs [OPTIONS] COMMAND [ARGS]...
2929
```
3030

3131
**Options**:
@@ -36,14 +36,14 @@ $ MyoQuant docs [OPTIONS] COMMAND [ARGS]...
3636

3737
* `generate`: Generate markdown version of usage...
3838

39-
### `MyoQuant docs generate`
39+
### `myoquant docs generate`
4040

4141
Generate markdown version of usage documentation
4242

4343
**Usage**:
4444

4545
```console
46-
$ MyoQuant docs generate [OPTIONS]
46+
$ myoquant docs generate [OPTIONS]
4747
```
4848

4949
**Options**:
@@ -52,14 +52,14 @@ $ MyoQuant docs generate [OPTIONS]
5252
* `--output FILE`: An output file to write docs to, like README.md.
5353
* `--help`: Show this message and exit.
5454

55-
## `MyoQuant he-analysis`
55+
## `myoquant he-analysis`
5656

5757
Run the HE analysis and quantification on the image.
5858

5959
**Usage**:
6060

6161
```console
62-
$ MyoQuant he-analysis [OPTIONS] IMAGE_PATH
62+
$ myoquant he-analysis [OPTIONS] IMAGE_PATH
6363
```
6464

6565
**Arguments**:
@@ -81,14 +81,14 @@ $ MyoQuant he-analysis [OPTIONS] IMAGE_PATH
8181
* `--fluo-nuc FILE`: The path to single channel fluo image for nuclei.
8282
* `--help`: Show this message and exit.
8383

84-
## `MyoQuant sdh-analysis`
84+
## `myoquant sdh-analysis`
8585

8686
Run the SDH analysis and quantification on the image.
8787

8888
**Usage**:
8989

9090
```console
91-
$ MyoQuant sdh-analysis [OPTIONS] IMAGE_PATH
91+
$ myoquant sdh-analysis [OPTIONS] IMAGE_PATH
9292
```
9393

9494
**Arguments**:
@@ -105,4 +105,3 @@ $ MyoQuant sdh-analysis [OPTIONS] IMAGE_PATH
105105
* `--export-map / --no-export-map`: Export the original image with cells painted by classification label. [default: export-map]
106106
* `--export-stats / --no-export-stats`: Export per fiber stat table. [default: export-stats]
107107
* `--help`: Show this message and exit.
108-

0 commit comments

Comments
 (0)