Skip to content

Commit

Permalink
Merge pull request pymeasure#1148 from kpet/doc-fixes
Browse files Browse the repository at this point in the history
A couple of documentation fixes
  • Loading branch information
BenediktBurger authored Aug 8, 2024
2 parents a4f076a + 14f296f commit bda7fd5
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 9 deletions.
9 changes: 1 addition & 8 deletions docs/dev/adding_instruments/instrument.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,6 @@ All standard instruments should be child class of :class:`Instrument <pymeasure.

The most basic instrument, for our "Extreme 5000" example starts like this:

.. testsetup::

# Behind the scene, replace Instrument with FakeInstrument to enable
# doctesting simple usage cases (default doctest group)
from pymeasure.instruments.fakes import FakeInstrument as Instrument


.. testcode::

#
Expand All @@ -78,7 +71,7 @@ The most basic instrument, for our "Extreme 5000" example starts like this:
# THE SOFTWARE.
#

# from pymeasure.instruments import Instrument
from pymeasure.instruments import Instrument

This is a minimal instrument definition:

Expand Down
2 changes: 1 addition & 1 deletion docs/dev/adding_instruments/properties.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ PyMeasure comes with three central convenience factory functions for making prop
You can call them, however, as :code:`Instrument.control`, :code:`Instrument.measurement`, and :code:`Instrument.setting`.

The :func:`Instrument.measurement <pymeasure.instruments.common_base.CommonBase.measurement>` function returns a property that can only read values from an instrument.
For example, if our "Extreme 5000" has the :code:`*IDN?` command, we can write the following property to be added after the :code:`def __init__` line in our above example class, or added to the class after the fact as in the code here:
For example, if our "Extreme 5000" has the :code:`:TEMP?` command, we can write the following property to be added after the :code:`def __init__` line in our above example class, or added to the class after the fact as in the code here:

.. _Python properties: https://docs.python.org/3/howto/descriptor.html#properties

Expand Down

0 comments on commit bda7fd5

Please sign in to comment.