From 599429e54b83f2687419a0b7bb560ce4cbc6c959 Mon Sep 17 00:00:00 2001 From: Tyler Goodlet Date: Thu, 26 Nov 2020 10:11:59 -0500 Subject: [PATCH] Tidy up doc string --- piker/data/_sharedmem.py | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/piker/data/_sharedmem.py b/piker/data/_sharedmem.py index 55f3675e..7f06bf78 100644 --- a/piker/data/_sharedmem.py +++ b/piker/data/_sharedmem.py @@ -342,21 +342,20 @@ def maybe_open_shm_array( dtype: Optional[np.dtype] = None, **kwargs, ) -> Tuple[ShmArray, bool]: - """Attempt to attach to a shared memory block by a - "key" determined by the users overall "system" + """Attempt to attach to a shared memory block using a "key" lookup + to registered blocks in the users overall "system" registryt (presumes you don't have the block's explicit token). - This function is meant to solve the problem of - discovering whether a shared array token has been - allocated or discovered by the actor running in - **this** process. Systems where multiple actors - may seek to access a common block can use this - function to attempt to acquire a token as discovered - by the actors who have previously stored a - "key" -> ``_Token`` map in an actor local variable. + This function is meant to solve the problem of discovering whether + a shared array token has been allocated or discovered by the actor + running in **this** process. Systems where multiple actors may seek + to access a common block can use this function to attempt to acquire + a token as discovered by the actors who have previously stored + a "key" -> ``_Token`` map in an actor local (aka python global) + variable. - If you know the explicit ``_Token`` for your memory - instead use ``attach_shm_array``. + If you know the explicit ``_Token`` for your memory segment instead + use ``attach_shm_array``. """ try: # see if we already know this key