Skip to content

Commit

Permalink
Minor docstring edits
Browse files Browse the repository at this point in the history
  • Loading branch information
philippjfr committed Apr 17, 2017
1 parent 521f7be commit 243bd41
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 16 deletions.
14 changes: 8 additions & 6 deletions holoviews/core/operation.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 6 additions & 6 deletions holoviews/core/spaces.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down
8 changes: 4 additions & 4 deletions holoviews/util.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.""")
Expand Down

0 comments on commit 243bd41

Please sign in to comment.