Skip to content

Commit

Permalink
Wrap docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
philippjfr committed Apr 10, 2022
1 parent 4d85435 commit 37b7693
Showing 1 changed file with 35 additions and 28 deletions.
63 changes: 35 additions & 28 deletions panel/widgets/indicators.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,14 @@ class BooleanIndicator(Indicator):


class BooleanStatus(BooleanIndicator):
"""The `BooleanStatus` is a boolean indicator providing a visual representation of a boolean
status as filled or non-filled circle.
"""
The `BooleanStatus` is a boolean indicator providing a visual
representation of a boolean status as filled or non-filled circle.
If the value is set to `True` the indicator will be filled while setting it to `False` will
cause it to be non-filled.
If the value is set to `True` the indicator will be filled while
setting it to `False` will cause it to be non-filled.
Reference: https://panel.holoviz.org/reference/indicators/BooleanStatus.html#indicators-gallery-booleanstatus
Reference: https://panel.holoviz.org/reference/indicators/BooleanStatus.html
:Example:
Expand Down Expand Up @@ -92,13 +93,14 @@ def _process_param_change(self, msg):


class LoadingSpinner(BooleanIndicator):
"""The `LoadingSpinner` is a boolean indicator providing a visual representation of the loading
status.
"""
The `LoadingSpinner` is a boolean indicator providing a visual
representation of the loading status.
If the value is set to `True` the spinner will rotate while setting it to `False` will disable the
rotating segment.
If the value is set to `True` the spinner will rotate while
setting it to `False` will disable the rotating segment.
Reference: https://panel.holoviz.org/reference/indicators/LoadingSpinner.html#indicators-gallery-loadingspinner
Reference: https://panel.holoviz.org/reference/indicators/LoadingSpinner.html
:Example:
Expand Down Expand Up @@ -150,14 +152,16 @@ class ValueIndicator(Indicator):


class Progress(ValueIndicator):
"""The `Progress` widget displays the progress towards some target based on the current `value`
and the `max` value.
"""
The `Progress` widget displays the progress towards some target
based on the current `value` and the `max` value.
If no `value` is set, the `Progress` widget is in indeterminate mode and will animate depending
on whether it is `active` or not. A more beautiful indicator for this use case is the
If no `value` is set, the `Progress` widget is in indeterminate
mode and will animate depending on whether it is `active` or
not. A more beautiful indicator for this use case is the
`LoadingSpinner`.
Reference: https://panel.holoviz.org/reference/indicators/Progress.html#indicators-gallery-progress
Reference: https://panel.holoviz.org/reference/indicators/Progress.html
:Example:
Expand Down Expand Up @@ -194,10 +198,10 @@ def __init__(self,**params):

class Number(ValueIndicator):
"""
The `Number` indicator renders the `value` as text optionally colored
according to the `colors` thresholds.
The `Number` indicator renders the `value` as text optionally
colored according to the `colors` thresholds.
Reference: https://panel.holoviz.org/reference/indicators/Number.html#indicators-gallery-number
Reference: https://panel.holoviz.org/reference/indicators/Number.html
:Example:
Expand Down Expand Up @@ -303,7 +307,7 @@ class Gauge(ValueIndicator):
speedometer or gauge. It is similar to a `Dial` but visually a lot
busier.
Reference: https://panel.holoviz.org/reference/indicators/Gauge.html#indicators-gallery-gauge
Reference: https://panel.holoviz.org/reference/indicators/Gauge.html
:Example:
Expand Down Expand Up @@ -426,9 +430,10 @@ def _process_param_change(self, msg):
class Dial(ValueIndicator):
"""
A `Dial` represents a value in some range as a position on an
annular dial. It is similar to a `Gauge` but more minimal visually.
annular dial. It is similar to a `Gauge` but more minimal
visually.
Reference: https://panel.holoviz.org/reference/indicators/Dial.html#indicators-gallery-dial
Reference: https://panel.holoviz.org/reference/indicators/Dial.html
:Example:
Expand Down Expand Up @@ -654,14 +659,15 @@ def _manual_update(self, events, model, doc, root, parent, comm):

class Trend(SyncableData, Indicator):
"""
The `Trend` indicator enables the user to display a dashboard kpi card.
The `Trend` indicator enables the user to display a dashboard kpi
card.
The card can be layout out as:
* a column (text and plot on top of each other) or
* a row (text and plot after each other)
* a column (text and plot on top of each other) or a row (text and
* plot after each other)
Reference: https://panel.holoviz.org/reference/indicators/Trend.html#indicators-gallery-trend
Reference: https://panel.holoviz.org/reference/indicators/Trend.html
:Example:
Expand Down Expand Up @@ -798,10 +804,11 @@ def close(self):

class Tqdm(Indicator):
"""
The `Tqdm` indicator wraps the well known `tqdm` progress indicator and displays the progress
towards some target in your Panel app.
The `Tqdm` indicator wraps the well known `tqdm` progress
indicator and displays the progress towards some target in your
Panel app.
Reference: https://panel.holoviz.org/reference/indicators/Tqdm.html#indicators-gallery-tqdm
Reference: https://panel.holoviz.org/reference/indicators/Tqdm.html
:Example:
Expand Down

0 comments on commit 37b7693

Please sign in to comment.