Skip to content

Commit 06ca777

Browse files
Minor grammatical changes from proof-reading
1 parent 457ea8d commit 06ca777

File tree

3 files changed

+10
-9
lines changed

3 files changed

+10
-9
lines changed

docs/explanations/why-use-pythonIoc.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,6 @@ allows you to write this as:
3838
# Leave the IOC running with an interactive shell.
3939
softioc.interactive_ioc(globals())
4040
41-
ADD THE CONCENTRATOR USE CASE HERE
42-
4341
Dynamically created PVs
4442
-----------------------
4543

docs/how-to/read-data-from-ioc.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Read data from an IOC
22
======================
33

4-
This guide explains how to read data from an IOC from a separate Python program.
4+
This guide explains how to read data from an IOC in a separate Python program.
55

66
.. note::
77
Please ensure your firewall allows both TCP and UDP traffic on ports 5064 and 5065.

docs/tutorials/creating-an-ioc.rst

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ functionality for Python soft IOCs and are the ones that are normally used.
2525

2626
:mod:`cothread` is one of the two possible libraries the IOC can use for
2727
asynchronous operations.
28-
(see :doc:`../how-to/use-asyncio-in-an-ioc` for the other option)
28+
(see :doc:`../how-to/use-asyncio-in-an-ioc` for the alternative)
2929

3030

3131

@@ -36,7 +36,10 @@ asynchronous operations.
3636
PVs are normally created dynamically using :mod:`softioc.builder`. All PV
3737
creation must be done before initialising the IOC. We define a lambda function for
3838
`on_update` on ``ao`` such that whenever we set ``ao``, ``ai`` will be set to the
39-
same value.
39+
same value. The ``always_update`` flag ensures that the ``on_update`` function is always
40+
triggered, which is not the default behaviour if the updated value is the same as the
41+
current value.
42+
4043

4144
.. literalinclude:: ../examples/example_cothread_ioc.py
4245
:start-after: # Boilerplate
@@ -53,7 +56,7 @@ which must be called in this order. After calling
5356
:end-before: # Finally
5457

5558
We define a long-running operation that will increment the value of ``ai`` once per
56-
second. This is run as a background process by `cothread`.
59+
second. This is run as a background thread by `cothread`.
5760

5861
.. literalinclude:: ../examples/example_cothread_ioc.py
5962
:start-after: # Finally
@@ -68,16 +71,16 @@ action.
6871

6972
In this interpreter there is immediate access to methods defined in the
7073
:mod:`softioc.softioc` module. For example the :func:`~softioc.softioc.dbgf` function
71-
can be run to observe the increasing value of ``ai``::
74+
can be run to observe the increasing value of ``AI``::
7275

7376
>>> dbgf("MY-DEVICE-PREFIX:AI")
7477
DBF_DOUBLE: 36
7578
>>> dbgf("MY-DEVICE-PREFIX:AI")
7679
DBF_DOUBLE: 37
7780

7881
And the :func:`~softioc.softioc.dbpf` method allows data to be set and to observe
79-
the functionality of the lambda passed to `on_update` . We set the value on ``ao``
80-
and read the value on ``ai`` (exact values will vary based on time taken)::
82+
the functionality of the lambda passed to ``on_update`` . We set the value on ``AO``
83+
and read the value on ``AI`` (exact values will vary based on time taken)::
8184

8285
>>> dbgf("MY-DEVICE-PREFIX:AI")
8386
DBF_DOUBLE: 15

0 commit comments

Comments
 (0)