Skip to content

Commit

Permalink
Update more docstring references to quantities
Browse files Browse the repository at this point in the history
  • Loading branch information
scasagrande committed Sep 2, 2020
1 parent 80e8e5a commit 1d39302
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion instruments/abstract_instruments/electrometer.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ def unit(self):
Gets/sets the measurement mode for the electrometer. This is an
abstract method.
:type: `~quantities.UnitQuantity`
:type: `~pint.Unit`
"""

@property
Expand Down
4 changes: 2 additions & 2 deletions instruments/hp/hp3456a.py
Original file line number Diff line number Diff line change
Expand Up @@ -412,8 +412,8 @@ def z(self, value):
def input_range(self):
"""Set the input range to be used.
The `HP3456a` has separate ranges for `~quantities.ohm` and for
`~quantities.volt`. The range value sent to the instrument depends on
The `HP3456a` has separate ranges for `ohm` and for
`volt`. The range value sent to the instrument depends on
the unit set on the input range value. `auto` selects auto ranging.
:type: `~pint.Quantity`
Expand Down
2 changes: 1 addition & 1 deletion instruments/keithley/keithley2182.py
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ def units(self):
"""
Gets the current measurement units of the instrument.
:rtype: `~quantities.unitquantity.UnitQuantity`
:rtype: `~pint.Unit`
"""
mode = self.channel[0].mode
if mode == Keithley2182.Mode.voltage_dc:
Expand Down
4 changes: 2 additions & 2 deletions instruments/lakeshore/lakeshore475.py
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ def field_units(self):
Acceptable units are Gauss, Tesla, Oersted, and Amp/meter.
:type: `~quantities.unitquantity.UnitQuantity`
:type: `~pint.Unit`
"""
value = int(self.query('UNIT?'))
return LAKESHORE_FIELD_UNITS[value]
Expand All @@ -124,7 +124,7 @@ def temp_units(self):
Acceptable units are celcius and kelvin.
:type: `~quantities.unitquantity.UnitQuantity`
:type: `~pint.Unit`
"""
value = int(self.query('TUNIT?'))
return LAKESHORE_TEMP_UNITS[value]
Expand Down
2 changes: 1 addition & 1 deletion instruments/ondax/lm.py
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ def target(self):
:return: the target laser power
:units: mW
:type: `~quantities.Quantities`
:type: `~pint.Quantity`
"""
response = self._parent.query("rslp?")
return float(response)*u.mW
Expand Down
4 changes: 2 additions & 2 deletions instruments/srs/srsctc100.py
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ def units(self):
Units can be one of ``celsius``, ``watt``, ``volt``, ``ohm``, or
``dimensionless``.
:type: `~quantities.UnitQuantity`
:type: `~pint.Unit`
"""
# FIXME: does not respect "chan.d/dt" property.
return self._ctc.channel_units()[self._chan_name]
Expand Down Expand Up @@ -222,7 +222,7 @@ def get_log_point(self, which='next', units=None):
:param units: Units to attach to the returned data point. If left
with the value of `None` then the instrument will be queried
for the current units setting.
:type units: `~quantities.UnitQuantity`
:type units: `~pint.Unit`
:return: The log data point with units
:rtype: `~pint.Quantity`
"""
Expand Down
2 changes: 1 addition & 1 deletion instruments/thorlabs/tc200.py
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ def degrees(self):
Gets/sets the units of the temperature measurement.
:return: The temperature units (degC/F/K) the TC200 is measuring in
:type: `~quantities.unitquantity.UnitTemperature`
:type: `~pint.Unit`
"""
response = self.status
if (response >> 4) % 2 and (response >> 5) % 2:
Expand Down

0 comments on commit 1d39302

Please sign in to comment.