Merge pull request #289 from ExaWorks/fix-docs-typos

docs and docstrings: fix typos

Author: jameshcorbett

QuickStart.md

@@ -40,7 +40,7 @@ Install psi-j from the github repository:
 
 **Steps**
 
-1. Create a file *my-worklfow.py* and copy and paste the code below:
+1. Create a file *my-workflow.py* and copy and paste the code below:
 
 ```python
 

README-testing.md

@@ -2,7 +2,7 @@ Introduction
 ============
 
 PSI/J comes with a testing infrastructure that allows users to contribute
-tests of the PSI/J library on resources they have access to and where
+tests of the PSI/J library itself on resources they have access to and where
 running such tests is appropriate.
 
 Contributed tests take the form of normal pytest runs for which results

README.md

@@ -8,6 +8,6 @@ PSI/J is an abstraction layer over cluster schedulers to write scheduler agnosti
 ## Introduction
 
 1. [Quick start guide](QuickStart.md)
-2. [Wrapping tools examples](scripts/WORKFLOW-EXAMPLES.md)
+2. [Workflow examples](scripts/WORKFLOW-EXAMPLES.md)
 3. [Setting up tests](README-testing.md)
 4. [How to contribute](CONTRIBUTING.md)

docs/getting_started.rst

@@ -53,9 +53,9 @@ other than complexity.
 If you write application code that is meant to run on various HPC clusters, but
 which never make calls to the underlying resource manager (e.g. by calling into
 Flux's client library, or executing ``srun``/``jsrun``/``aprun`` etc.), then
-PSI/J will not help you. This is likely your situation if you work on a MPI-based
-science simulation, since we have observed that it is often the users' responsibility
-to actually launch the simulation through the resource manager.
+PSI/J will not help you. This is likely your situation if you are a developer working
+on a MPI-based science simulation, since we have observed that it is often the users'
+responsibility to actually launch the simulation through the resource manager.
 However, PSI/J is more likely to help with various tools
 associated with your simulation--for instance, your test suite.
 

src/psij/executors/batch/pbspro.py

@@ -54,7 +54,7 @@ class PBSProJobExecutor(BatchSchedulerExecutor):
     `PBS Pro <https://www.altair.com/pbs-professional/>`_ is a resource manager
     on certain machines at Argonne National Lab, among others.
 
-    Uses the 'qsub', 'qstat', and 'qdel' commands, respectively, to submit,
+    Uses the ``qsub``, ``qstat``, and ``qdel`` commands, respectively, to submit,
     monitor, and cancel jobs.
 
     Creates a batch script with #PBS directives when submitting a job.

src/psij/launchers/aprun.py

@@ -8,7 +8,7 @@
 
 
 class AprunLauncher(MultipleLauncher):
-    """Launches a job using Cobalt's `aprun`."""
+    """Launches a job using Cobalt's ``aprun``."""
 
     def __init__(self, config: Optional[JobExecutorConfig] = None):
         """

src/psij/launchers/jsrun.py

@@ -8,7 +8,7 @@
 
 
 class JsrunLauncher(MultipleLauncher):
-    """Launches a job using LSF's `jsrun`."""
+    """Launches a job using LSF's ``jsrun``."""
 
     def __init__(self, config: Optional[JobExecutorConfig] = None):
         """

src/psij/launchers/srun.py

@@ -7,7 +7,7 @@
 
 
 class SrunLauncher(MultipleLauncher):
-    """Launches a job using Slurm's `srun`.
+    """Launches a job using Slurm's ``srun``.
 
     See the
     `Slurm Workload Manager <https://slurm.schedmd.com/overview.html>`_.