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

Widgets.continuous_update has confusing documentationΒ #58

@ceball

Description

@ceball

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).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions