Tidy up doc string

tina_free_vwap
Tyler Goodlet 2020-11-26 10:11:59 -05:00
parent ea8f17c94b
commit 599429e54b
1 changed files with 11 additions and 12 deletions

View File

@ -342,21 +342,20 @@ def maybe_open_shm_array(
dtype: Optional[np.dtype] = None, dtype: Optional[np.dtype] = None,
**kwargs, **kwargs,
) -> Tuple[ShmArray, bool]: ) -> Tuple[ShmArray, bool]:
"""Attempt to attach to a shared memory block by a """Attempt to attach to a shared memory block using a "key" lookup
"key" determined by the users overall "system" to registered blocks in the users overall "system" registryt
(presumes you don't have the block's explicit token). (presumes you don't have the block's explicit token).
This function is meant to solve the problem of This function is meant to solve the problem of discovering whether
discovering whether a shared array token has been a shared array token has been allocated or discovered by the actor
allocated or discovered by the actor running in running in **this** process. Systems where multiple actors may seek
**this** process. Systems where multiple actors to access a common block can use this function to attempt to acquire
may seek to access a common block can use this a token as discovered by the actors who have previously stored
function to attempt to acquire a token as discovered a "key" -> ``_Token`` map in an actor local (aka python global)
by the actors who have previously stored a variable.
"key" -> ``_Token`` map in an actor local variable.
If you know the explicit ``_Token`` for your memory If you know the explicit ``_Token`` for your memory segment instead
instead use ``attach_shm_array``. use ``attach_shm_array``.
""" """
try: try:
# see if we already know this key # see if we already know this key