Skip to content

Commit

Permalink
Add method signature overrides to docstrings
Browse files Browse the repository at this point in the history
Also fixed a typo in the set_disabled() docstring 's/enabled/disabled'.
  • Loading branch information
BrianJKoopman committed Nov 15, 2024
1 parent b321915 commit 8f73baa
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions socs/agents/xy_stage/agent.py
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,10 @@ def set_position(self, session, params):

@ocs_agent.param('_')
def set_enabled(self, session, params=None):
"""Tell the controller to hold stages enabled
"""set_enabled()
**Task** - Tell the controller to hold stages enabled.
"""
with self.lock.acquire_timeout(timeout=3, job='set_enabled') as acquired:
if not acquired:
Expand All @@ -179,7 +182,10 @@ def set_enabled(self, session, params=None):

@ocs_agent.param('_')
def set_disabled(self, session, params=None):
"""Tell the controller to hold stages enabled
"""set_disabled()
**Task** - Tell the controller to hold stages disabled.
"""
with self.lock.acquire_timeout(timeout=3, job='set_disabled') as acquired:
if not acquired:
Expand Down

0 comments on commit 8f73baa

Please sign in to comment.