Removed outdated docstring content from DynamicMap
@@ -452,53 +452,24 @@ def get_nested_streams(dmap):
class DynamicMap(HoloMap):
"""
A DynamicMap is a type of HoloMap where the elements are dynamically
- generated by a callback which may be either a callable or a
- generator. A DynamicMap supports two different modes depending on
- the type of callable supplied and the dimension declarations.
-
- The 'bounded' mode is used when the limits of the parameter space
- are known upon declaration (as specified by the ranges on the key
- dimensions) or 'open' which allows the continual generation of
- elements (e.g as data output by a simulator over an unbounded
- simulated time dimension).
-
- Generators always imply open mode but a callable that has any key
- dimension unbounded in any direction will also be in open
- mode. Bounded mode only applied to callables where all the key
- dimensions are fully bounded.
+ generated by a callable. The callable is invoked with values
+ associated with the key dimensions or with values supplied by stream
+ parameters.
"""
# Declare that callback is a positional parameter (used in clone)
__pos_params = ['callback']
callback = param.Parameter(doc="""
- The callable or generator used to generate the elements. In the
- simplest case where all key dimensions are bounded, this can be
- a callable that accepts the key dimension values as arguments
- (in the declared order) and returns the corresponding element.
-
- For open mode where there is an unbounded key dimension, the
- return type can specify a key as well as element as the tuple
- (key, element). If no key is supplied, a simple counter is used
- instead.
-
- If the callback is a generator, open mode is used and next() is
- simply called. If the callback is callable and in open mode, the
- element counter value will be supplied as the single
- argument. This can be used to avoid issues where multiple
- elements in a Layout each call next() leading to uncontrolled
- changes in simulator state (the counter can be used to indicate
- simulation time across the layout).
- """)
+ The callable used to generate the elements. The arguments to the
+ callable includes any number of declared key dimensions as well
+ as any number of stream parameters defined on the input streams.""")
streams = param.List(default=[], doc="""
List of Stream instances to associate with the DynamicMap. The
set of parameter values across these streams will be supplied as
keyword arguments to the callback when the events are received,
- updating the streams.
-
- Note that streams may only be used with callable callbacks (i.e
- not generators).""" )
+ updating the streams.""" )
cache_size = param.Integer(default=500, doc="""
The number of entries to cache for fast access. This is an LRU
