Test formatting

sunbeam-labs · Oct 12, 2022 · 6cac50c · 6cac50c
1 parent f5c4520
commit 6cac50c
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 6 deletions.
diff --git a/docs/commands.rst b/docs/commands.rst
@@ -7,11 +7,12 @@ Sunbeam Commands
 .. contents::
    :depth: 2
 
-sunbeam [-h | -v] <subcommand>
+.. code::
+    sunbeam [-h | -v] <subcommand>
 
--h/--help: Display help.
+    -h/--help: Display help.
 
--v/--version: Display version.
+    -v/--version: Display version.
 
 .. tip::
 
@@ -41,14 +42,14 @@ sunbeam init [-h] [-f] [--output FILE] [--defaults FILE] [--template FILE]
 
 --single_end: Fastq files are in single-end, not paired-end, format for --data_fp.
 
-project_fp: 
+project_fp: Project directory (will be created if it does not exist).
 
 run
 ===
 
 sunbeam run [-h] [-s PATH] -- <snakemake options>
 
--h: Display help.
+-h/--help: Display help.
 
 -s/--sunbeam_dir: Path to sunbeam installation.
 

diff --git a/docs/structure.rst b/docs/structure.rst
@@ -98,7 +98,7 @@ tests/
 
 This directory contains all of the testing framework and tests for sunbeam. The 
 framework is written mostly in bash with `test_suite.bash` holding the main 
-test suite and `run_tests.bash` to run it.
+test suite and `run_tests.bash` to run it. 
 
 Hidden Directories
 ------------------