Skip to content

Commit

Permalink
fix persistent_support docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
jlnav committed Oct 8, 2021
1 parent 8cfeeff commit f1ba012
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions libensemble/tools/persistent_support.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ class PersistentSupport:
"""A helper class to assist with writing allocation functions."""

def __init__(self, libE_info, calc_type):
"""Instantiate a new PersistentSupport instance
"""
Instantiate a new PersistentSupport instance
:param libE_info: A dictionary containing information about this work request
:param calc_type: Named integer giving calculation type - EVAL_GEN_TAG or EVAL_SIM_TAG
Expand All @@ -20,7 +22,9 @@ def __init__(self, libE_info, calc_type):
self.calc_str = calc_type_strings[self.calc_type]

def send(self, output, calc_status=UNSET_TAG):
"""Send message from worker to manager.
"""
Send message from worker to manager.
:param output: Output array to be sent to manager
:param calc_status: Optional, Provides a task status
Expand All @@ -43,7 +47,9 @@ def send(self, output, calc_status=UNSET_TAG):
self.comm.send(self.calc_type, D)

def recv(self):
"""Receive message to worker from manager.
"""
Receive message to worker from manager.
:returns: message tag, Work dictionary, calc_in array
"""
Expand Down Expand Up @@ -74,9 +80,11 @@ def recv(self):
return tag, Work, calc_in

def send_recv(self, output, calc_status=UNSET_TAG):
"""Send message from worker to manager and receive response.
"""
Send message from worker to manager and receive response.
:param output: Output array to be sent to manager
:param calc_status::Optional, Provides a task status
:param calc_status: Optional, Provides a task status
:returns: message tag, Work dictionary, calc_in array
Expand Down

0 comments on commit f1ba012

Please sign in to comment.