Merge pull request #49 from smart-on-fhir/mikix/doc-fix

docs: prevent double-hyphens from being converted to a dash
smart-on-fhir · Jun 27, 2024 · 075d567 · 075d567
2 parents a515d18 + 026d820
commit 075d567
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 6 deletions.
diff --git a/docs/accuracy.md b/docs/accuracy.md
@@ -31,7 +31,7 @@ F1     Sens  Spec  PPV  NPV   Kappa  TP  FN  TN  FP  Label
 
 ## Options
 
-### --verbose
+### \-\-verbose
 
 Use this to also print out a table of per-chart/per-label classifications.
 This is helpful for investigating where specifically the two annotators agreed or not.
@@ -61,7 +61,7 @@ Annotator: jane
 ╰──────────┴──────────┴────────────────╯
 ```
 
-### --csv
+### \-\-csv
 
 Print the accuracy chart in a machine-parseable CSV format.
 

diff --git a/docs/frequency.md b/docs/frequency.md
@@ -55,7 +55,7 @@ $ chart-review frequency
 
 ## Options
 
-### --csv
+### \-\-csv
 
 Print the frequencies in a machine-parseable CSV format.
 

diff --git a/docs/ids.md b/docs/ids.md
@@ -70,7 +70,7 @@ $ chart-review ids
 
 ## Options
 
-### --csv
+### \-\-csv
 
 Print the IDs in a machine-parseable CSV format.
 

diff --git a/docs/labels.md b/docs/labels.md
@@ -38,7 +38,7 @@ $ chart-review labels
 
 ## Options
 
-### --csv
+### \-\-csv
 
 Print the labels in a machine-parseable CSV format.
 

diff --git a/docs/mentions.md b/docs/mentions.md
@@ -40,7 +40,7 @@ $ chart-review mentions
 
 ## Options
 
-### --csv
+### \-\-csv
 
 Print the mentions in a machine-parseable CSV format.