Update docstrings 🧾

Author: ibdafna

packages/controls/src/widget_float.ts

@@ -7,7 +7,7 @@ import {
   BaseIntSliderView,
   IntRangeSliderView,
   IntSliderView,
-  IntTextView,
+  IntTextView
 } from './widget_int';
 
 import { format } from 'd3-format';
@@ -103,7 +103,7 @@ export class FloatLogSliderModel extends BoundedFloatModel {
   readout_formatter: any;
 }
 
-export class FloatRangeSliderModel extends FloatSliderModel {}
+export class FloatRangeSliderModel extends FloatSliderModel { }
 
 export class FloatSliderView extends IntSliderView {
   /**
@@ -166,7 +166,8 @@ export class FloatLogSliderView extends BaseIntSliderView {
       },
     });
 
-    // Using noUiSlider's event handler
+    // Using noUiSlider's 'update' and 'change' events.
+    // See reference: https://refreshless.com/nouislider/events-callbacks/
     this.$slider.noUiSlider.on('update', (values: any, handle: any) => {
       this.handleSliderUpdateEvent(values, handle);
     });
@@ -222,8 +223,9 @@ export class FloatLogSliderView extends BaseIntSliderView {
       }
     }
   }
+
   /**
-   * Called when the slider value is changing.
+   * Called whilst the slider is dragged, tapped or moved by the arrow keys.
    */
   handleSliderUpdateEvent(values: number[], handle: number): void {
     const base = this.model.get('base');
@@ -237,6 +239,10 @@ export class FloatLogSliderView extends BaseIntSliderView {
     }
   }
 
+  /**
+   * Called when the slider handle is released after dragging, 
+   * or by tapping or moving by the arrow keys.
+   */
   handleSliderChangeEvent(values: number[], handle: number): void {
     const base = this.model.get('base');
     const actual_value = Math.pow(base, this._validate_slide_value(values[0]));

packages/controls/src/widget_int.ts

@@ -78,7 +78,7 @@ export class IntSliderModel extends BoundedIntModel {
   readout_formatter: any;
 }
 
-export class IntRangeSliderModel extends IntSliderModel {}
+export class IntRangeSliderModel extends IntSliderModel { }
 
 export abstract class BaseIntSliderView extends DescriptionView {
   render(): void {
@@ -223,7 +223,8 @@ export abstract class BaseIntSliderView extends DescriptionView {
       },
     });
 
-    // Using noUiSlider's event handler
+    // Using noUiSlider's 'update' and 'change' events.
+    // See reference: https://refreshless.com/nouislider/events-callbacks/
     this.$slider.noUiSlider.on('update', (values: any, handle: any) => {
       this.handleSliderUpdateEvent(values, handle);
     });
@@ -268,12 +269,13 @@ export abstract class BaseIntSliderView extends DescriptionView {
   abstract handleTextChange(): void;
 
   /**
-   * Called when the slider value changes on mouseUp.
+   * Called when the slider handle is released after dragging, 
+   * or by tapping or moving by the arrow keys.
    */
   abstract handleSliderChangeEvent(value: any, handle: any): void;
 
   /**
-   * Called when the slider value changes whilst dragging.
+   * Called whilst the slider is dragged, tapped or moved by the arrow keys.
    */
   abstract handleSliderUpdateEvent(value: any, handle: any): void;
 
@@ -371,13 +373,20 @@ export class IntRangeSliderView extends BaseIntSliderView {
     }
   }
 
+  /**
+   * Called when the slider handle is released after dragging, 
+   * or by tapping or moving by the arrow keys.
+   */
   handleSliderChangeEvent(values: any, handle: any): void {
     const actual_value = values.map(this._validate_slide_value);
     this.readout.textContent = this.valueToString(actual_value);
 
     this.handleSliderChanged(values, handle);
   }
 
+  /**
+   * Called whilst the slider is dragged, tapped or moved by the arrow keys.
+   */
   handleSliderUpdateEvent(values: any, handle: any): void {
     const actual_value = values.map(this._validate_slide_value);
     this.readout.textContent = this.valueToString(actual_value);

packages/controls/src/widget_selection.ts

@@ -498,7 +498,7 @@ export class ToggleButtonsView extends DescriptionView {
     const previous_icons = this.model.previous('icons') || [];
     const previous_bstyle =
       (ToggleButtonsView.classMap as any)[
-        this.model.previous('button_style')
+      this.model.previous('button_style')
       ] || '';
     const tooltips = this.model.get('tooltips') || [];
     const disabled = this.model.get('disabled');
@@ -769,7 +769,8 @@ export class SelectionSliderView extends DescriptionView {
       },
     });
 
-    // Using noUiSlider's event handler
+    // Using noUiSlider's 'update' and 'change' events.
+    // See reference: https://refreshless.com/nouislider/events-callbacks/
     this.$slider.noUiSlider.on('update', (values: number[], handle: number) => {
       this.handleSliderUpdateEvent(values, handle);
     });
@@ -797,7 +798,7 @@ export class SelectionSliderView extends DescriptionView {
   }
 
   /**
-   * Called when the slider value changes whilst dragging.
+   * Called whilst the slider is dragged, tapped or moved by the arrow keys.
    */
   handleSliderUpdateEvent(values: number[], handle: number): void {
     const index = values[0];
@@ -811,7 +812,8 @@ export class SelectionSliderView extends DescriptionView {
   }
 
   /**
-   * Called on a mouseUp event.
+   * Called when the slider handle is released after dragging, 
+   * or by tapping or moving by the arrow keys.
    */
   handleSliderChangeEvent(values: number[], handle: number): void {
     const index = values[0];