From 243bd41d8472d6e25e3e6f11bf0277d75ca69990 Mon Sep 17 00:00:00 2001 From: Philipp Rudiger Date: Mon, 17 Apr 2017 12:43:50 +0100 Subject: [PATCH] Minor docstring edits --- holoviews/core/operation.py | 14 ++++++++------ holoviews/core/spaces.py | 12 ++++++------ holoviews/util.py | 8 ++++---- 3 files changed, 18 insertions(+), 16 deletions(-) diff --git a/holoviews/core/operation.py b/holoviews/core/operation.py index 34d016eafe..bec1de49cb 100644 --- a/holoviews/core/operation.py +++ b/holoviews/core/operation.py @@ -104,12 +104,14 @@ class ElementOperation(Operation): component is Normalization.keys. """) link_inputs = param.Boolean(default=False, doc=""" - If the operation is dynamic, whether or not linked streams - should be transferred from the operation inputs for backends - that support linked streams. For example if an operation is - applied to a DynamicMap with an RangeXY determines if the - output of the operation will update the stream on the input - with current axis ranges.""") + If the operation is dynamic, whether or not linked streams + should be transferred from the operation inputs for backends + that support linked streams. + + For example if an operation is applied to a DynamicMap with an + RangeXY, this switch determines whether the corresponding + visualization should update this stream with range changes + originating from the newly generated axes.""") streams = param.List(default=[], doc=""" List of streams that are applied if dynamic=True, allowing diff --git a/holoviews/core/spaces.py b/holoviews/core/spaces.py index ca70665c62..cc8ba4ae31 100644 --- a/holoviews/core/spaces.py +++ b/holoviews/core/spaces.py @@ -406,7 +406,7 @@ class Callable(param.Parameterized): visualizations (for the backends that support them) when returning Layouts, NdLayouts or GridSpace objects. When chaining multiple DynamicMaps into a pipeline, the link_inputs parameter declares - whether the visualization generated from this Callable will + whether the visualization generated using this Callable will inherit the linked streams. This parameter is used as a hint by the applicable backend. @@ -426,13 +426,13 @@ class Callable(param.Parameterized): link_inputs = param.Boolean(default=True, doc=""" If the Callable wraps around other DynamicMaps in its inputs, - determines if linked streams attached to the inputs areb + determines whether linked streams attached to the inputs are transferred to the objects returned by the Callable. - For example if the Callable wraps a DynamicMap with an - RangeXY stream determines if the output of the Callable will - update the stream on the input with current axis ranges for - backends that support linked streams.""") + For example the Callable wraps a DynamicMap with an RangeXY + stream, this switch determines whether the corresponding + visualization should update this stream with range changes + originating from the newly generated axes.""") memoize = param.Boolean(default=True, doc=""" Whether the return value of the callable should be memoized diff --git a/holoviews/util.py b/holoviews/util.py index c4044fe276..e622070cd2 100644 --- a/holoviews/util.py +++ b/holoviews/util.py @@ -29,14 +29,14 @@ class Dynamic(param.ParameterizedFunction): Keyword arguments passed to the function.""") link_inputs = param.Boolean(default=True, doc=""" - If Dynamic is applied to another DynamicMap, determines if + If Dynamic is applied to another DynamicMap, determines whether linked streams attached to its Callable inputs are transferred to the output of the utility. For example if the Dynamic utility is applied to a DynamicMap - with an RangeXY stream determines if the output of the - utility will update the stream on the input with current axis - ranges for backends that support linked streams.""") + with an RangeXY, this switch determines whether the + corresponding visualization should update this stream with + range changes originating from the newly generated axes.""") shared_data = param.Boolean(default=False, doc=""" Whether the cloned DynamicMap will share the same cache.""")