Skip to content

Commit

Permalink
Merge pull request #133 from DiamondLightSource/artemis_835_trans_docs
Browse files Browse the repository at this point in the history
Added better docstrings for the attenuator
  • Loading branch information
DominicOram authored Aug 3, 2023
2 parents 422bf58 + e9d01e1 commit 443c1fd
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions src/dodal/devices/attenuator.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,15 @@ class AtteunatorFilter(Device):


class Attenuator(Device):
# Sets transmission - range 0-1
def set(self, transmission) -> SubscriptionStatus:
"""Get desired states and calculated states, return a status which is complete once they are equal"""
"""Any reference to transmission (both read and write) in this Device is fraction
e.g. 0-1"""

def set(self, transmission: float) -> SubscriptionStatus:
"""Set the transmission to the fractional value given.
Args:
transmission (float): A fraction to set transmission to between 0-1
Get desired states and calculated states, return a status which is complete once they are equal
"""

LOGGER.info("Using current energy ")
self.use_current_energy.set(1).wait()
Expand Down

0 comments on commit 443c1fd

Please sign in to comment.