Skip to content
This repository has been archived by the owner on Nov 28, 2019. It is now read-only.

Widgets.continuous_update has confusing documentation #58

Open
ceball opened this issue Jul 2, 2017 · 1 comment
Open

Widgets.continuous_update has confusing documentation #58

ceball opened this issue Jul 2, 2017 · 1 comment

Comments

@ceball
Copy link
Member

ceball commented Jul 2, 2017

The name and docstring for continuous_update make it sound like it does more than it actually does.

   continuous_update = param.Boolean(default=False, doc="""
        If true, will continuously update the next_n and/or callback, 
        if any, as a slider widget is dragged.""")

E.g. if you have Widgets.button=True and continuous_update=True, the next_n cells are not executed as any slider widget is dragged.

I think it should be something more like:

   slider_continuous_update = param.Boolean(default=False, doc="""
        If False, only set slider values when the mouse is released after dragging.""")

I'm proposing the name change because I missed that it only applies to slider widgets at first (in combination with what I'd consider "continuous update" being controlled by a parameter called button).

@jbednar
Copy link
Member

jbednar commented Jul 6, 2017

Fine by me.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants