Skip to content

Commit 925a426

Browse files
authored
Merge pull request #335 from dihenriksen/dihenriksen-patch-1
Tutorial spelling and grammar cleanup
2 parents 07cb925 + c63be93 commit 925a426

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

docs/source/tutorials.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -539,7 +539,7 @@ execution time about 60 seconds::
539539
Open the environment as described in :ref:`tutorial_opening_closing_re_worker_environment`.
540540

541541
Every plan that is executed by RE Manager is added to the plan history. The history
542-
is not designed to for long-term storage and must be periodically cleared::
542+
is not designed for long-term storage and must be periodically cleared::
543543

544544
$ qserver history clear
545545
11:51:11 - MESSAGE:
@@ -794,7 +794,7 @@ was fully completed and not repeated after the plan was resumed::
794794
The following sequence of commands starts the queue and request immediate pause.
795795
The sequence may be tested with the same plan::
796796

797-
$ qserver start
797+
$ qserver queue start
798798
$ qserver re pause immediate
799799
$ qserver re resume
800800

@@ -825,8 +825,8 @@ and repeated after the plan was resumed::
825825
generator count ['76e20bbc'] (scan num: 2)
826826

827827
Once the plan is paused, it can be resumed (as alread demonstrated), stopped, aborted or halted. The
828-
technical difference between the three methods of terminating a plan relatively small, except that
829-
stopped plans is considered successful, aborted and halted plans are considered failed; a new plan
828+
technical differences among the three methods of terminating a plan are relatively small, except that
829+
a stopped plan is considered successful, while aborted and halted plans are considered failed; a new plan
830830
can be started immediately after a plan is stopped or aborted, but the environment needs to be
831831
restarted (closed and opened again) after a plan is halted.
832832

@@ -1049,7 +1049,7 @@ and check the status. The number of background tasks is now 2::
10491049

10501050
The manager and environment state is ``'idle'``, which means that users are free to run plans or foreground
10511051
tasks without waiting for the background tasks to complete. Background tasks can also be started while
1052-
plans or forground tasks are running. Try running the function as a foreground task. Also try running
1052+
plans or foreground tasks are running. Try running the function as a foreground task. Also try running
10531053
a plan while the function is running. Also try running one or multiple copies of the function while
10541054
a plan or a foreground task is running.
10551055

@@ -1639,8 +1639,8 @@ Locking RE Manager
16391639
RE Manager can be temporarily locked by a user using a 'secret' key. The user is expected to
16401640
remember (or keep) the key and unlock the manager when safe. The user may choose to
16411641
lock the worker environment and/or the queue which prevents other users
1642-
to change the state of environment (start the queue, run plans, upload scripts etc.) or
1643-
the queue (add, edit or reorder plans in the queue etc.) unless they are provided with the key.
1642+
from changing the state of the environment (start the queue, run plans, upload scripts, etc.) or
1643+
the queue (add, edit, or reorder plans in the queue, etc.) unless they are provided with the key.
16441644
For more detailed description see :ref:`locking_re_manager`.
16451645

16461646
Start RE Manager using instructions given in :ref:`tutorial_starting_queue_server`.
@@ -1679,7 +1679,7 @@ When the manager is locked, the status includes the name of the user (``user``)
16791679
the lock, time (``time``, ``time_str``) when the lock was applied and optional note (``note``)
16801680
for other users of the system, explaining the reason why the lock was applied.
16811681
The parameter ``emergency_lock_key_is_set`` (``False``) indicates that the emergency key is
1682-
not set and the manager can be unlocked only only with the key used to lock it.
1682+
not set and the manager can be unlocked only with the key used to lock it.
16831683

16841684
Lock the environment with a note::
16851685

@@ -2068,7 +2068,7 @@ RE Manager generates or updates the list of existing plans and devices automatic
20682068
RE Worker environment is opened, but in some cases it is convenient to generate
20692069
the list manually. For example, the developers wishing to update ``existing_plans_and_devices.yaml``
20702070
in `the 'profile_collection_sim' directory <https://github.com/bluesky/bluesky-queueserver/tree/main/bluesky_queueserver/profile_collection_sim>`_
2071-
when the respective startup files are modified have the only option to do it manually (RE Manager
2071+
when the respective startup files are modified only have the option to do it manually (RE Manager
20722072
is designed not to automatically modify files in built-in ``profile_collection_sim`` directory).
20732073

20742074
**Step 1.** Create the directory with startup files and copy startup Python files as
@@ -2126,7 +2126,7 @@ disables printing of the console output::
21262126

21272127
$ start-re-manager --zmq-publish-console ON --console-output OFF
21282128

2129-
Notice that no output is printed in Terminal2. External monitor (running in
2129+
Notice that no output is printed in Terminal2. External monitoring (running in
21302130
Terminal 1) is needed to visualize the output from RE Manager.
21312131

21322132
In practice, the client applications are expected to implement the

0 commit comments

Comments
 (0)