fix dashes in nengines argument in docs

WelbornGroup · Oct 7, 2020 · b169127 · b169127
1 parent f9b7d24
commit b169127
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/ELECTRIC/util.py b/ELECTRIC/util.py
@@ -244,7 +244,7 @@ def index_fragments(fragment_list, ipoles):
     for fragment in fragments:
         # These are the atom numbers for the atoms in the specified molecules
         fragment_atoms = np.array(np.where(fragment_list == fragment)) + 1
-        # The pole indices for the speified molecule
+        # The pole indices for the specified molecule
         pole_numbers = [ipoles[atom_index - 1] for atom_index in fragment_atoms[0]]
         atoms_pole_numbers.append(np.array(pole_numbers))
 

diff --git a/README.md b/README.md
@@ -124,7 +124,7 @@ You can see command line arguments for this driver using the following command f
 Here is the help information for the command line arguments:
 
     usage: ELECTRIC.py [-h] -mdi MDI -snap SNAP -probes PROBES
-                              [-nengines NENGINES] [--equil EQUIL]
+                              [--nengines NENGINES] [--equil EQUIL]
                               [--stride STRIDE] [--byres BYRES] [--bymol]
 
     required arguments:
@@ -139,7 +139,7 @@ Here is the help information for the command line arguments:
 
     optional arguments:
       -h, --help          show this help message and exit
-      -nengines NENGINES  This option allows the driver to farm tasks out to
+      --nengines NENGINES This option allows the driver to farm tasks out to
                           multiple Tinker engines simultaneously, enabling
                           parallelization of the electric field analysis
                           computation. The argument to this option **must** be

diff --git a/docs/usage.rst b/docs/usage.rst
@@ -34,7 +34,7 @@ One possible launch command would be:
 
 .. code-block:: bash
 
-    `python ${DRIVER_LOC} -probes "1 2 10" -snap coordinates.arc -mdi "-role DRIVER -name driver -method TCP -port 8021" --byres ke15.pdb --equil 51 -nengines 15 &`
+    `python ${DRIVER_LOC} -probes "1 2 10" -snap coordinates.arc -mdi "-role DRIVER -name driver -method TCP -port 8021" --byres ke15.pdb --equil 51 --nengines 15 &`
 
 where `DRIVER_LOC` is the path to ELECTRIC.py which you set during the configuration step. See the section :ref:`electric settings` for a detailed explanation of command line arguments for ELECTRIC.
 
@@ -68,7 +68,7 @@ Example Script
     done
 
     # launch the driver
-    python ${DRIVER_LOC} -probes "32 33 59 60" -snap coordinates.arc -mdi "-role DRIVER -name driver -method TCP -port 8021" --byres ke15.pdb --equil 51 -nengines ${nengines} &
+    python ${DRIVER_LOC} -probes "32 33 59 60" -snap coordinates.arc -mdi "-role DRIVER -name driver -method TCP -port 8021" --byres ke15.pdb --equil 51 --nengines ${nengines} &
 
     wait