Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added better docstrings for the attenuator #133

Merged
merged 1 commit into from
Aug 3, 2023
Merged

Added better docstrings for the attenuator #133

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions src/dodal/devices/attenuator.py
View file
Open in desktop
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