Skip to content

Commit 797eeac

Browse files
committed
docs(scout): reflect changes to cli in docs
Signed-off-by: Tarik Zegmott <tarik.zegmott@mcgill.ca>
1 parent c7ab294 commit 797eeac

1 file changed

Lines changed: 12 additions & 10 deletions

File tree

docs/scout.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# 🕵️ Investigating a dataset with scout
22

33
<!-- termynal -->
4+
45
```bash
56
❯ datatrail scout --help
6-
Usage: datatrail scout [OPTIONS] DATASET [SCOPES]...
7+
Usage: datatrail scout [OPTIONS] [SCOPES]... DATASET
78

89
Scout a dataset.
910

@@ -28,14 +29,14 @@ filtered to only show information for the `chime.event.baseband.raw` scope
2829
and unfiltered.
2930

3031
!!! note
31-
The output below does not show the correct colouring. The rows of the table
32-
are colour-coded to indicate if it is observed or expected. Observed
33-
values are displayed in blue and expected values are in yellow.
32+
The output below does not show the correct colouring. The rows of the table
33+
are colour-coded to indicate if it is observed or expected. Observed
34+
values are displayed in blue and expected values are in yellow.
3435

3536
=== "Filtering by scope"
3637

3738
```bash
38-
❯ datatrail scout 382085503 chime.event.baseband.raw
39+
❯ datatrail scout chime.event.baseband.raw 382085503
3940
Scout Results for 382085503
4041
┏━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━┳━━━━━┳━━━━━┳━━━━━━━┓
4142
┃ Scope ┃ chime ┃ baseband_buffer ┃ kko ┃ gbo ┃ hco ┃ minoc ┃
@@ -48,7 +49,7 @@ and unfiltered.
4849
this may be due to the file type filtering when querying each site. This is a
4950
known limitation of the current implementation.
5051
```
51-
52+
5253
1. The Observed number of files.
5354
2. The Expected number of files.
5455

@@ -76,18 +77,19 @@ and unfiltered.
7677
```
7778

7879
!!! failure "Negative files"
79-
If the server encounters an error it is represented as a negative number.
80-
Which can occur when communicating with the mini-servers running at each
81-
storage element.
80+
If the server encounters an error it is represented as a negative number.
81+
Which can occur when communicating with the mini-servers running at each
82+
storage element.
8283

8384
### Healing at Minoc
85+
8486
In some cases, the number of files expected at minoc may be less than the number
8587
that actually exist there. This can occur when API requests drop, leading to an
8688
inconsistent state in the database. When this is seen by `scout`, the command
8789
offers to remedy the situation by adding the missing replicas.
8890

8991
```bash
90-
❯ datatrail scout 383577603 chime.event.baseband.raw
92+
❯ datatrail scout chime.event.baseband.raw 383577603
9193
Scout Results for 383577603
9294
┏━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━┳━━━━━┳━━━━━┳━━━━━━━┓
9395
┃ Scope ┃ chime ┃ baseband_buffer ┃ kko ┃ gbo ┃ hco ┃ minoc ┃

0 commit comments

Comments
 (0)