Skip to content

Commit 7055c26

Browse files
improve docstring
1 parent 90d8b11 commit 7055c26

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

nicegui_highcharts/highchart.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,14 @@ def __init__(self, options: dict, *,
2222
"""Highcharts chart
2323
2424
An element to create a chart using `Highcharts <https://www.highcharts.com/>`_.
25-
Updates can be pushed to the chart by changing the `options` property.
26-
After data has changed, call the `update` method to refresh the chart.
25+
Updates can be pushed to the chart by changing the ``options`` property.
2726
2827
Due to Highcharts' restrictive license, this element is not part of the standard NiceGUI package.
2928
It is maintained in a `separate repository <https://github.com/zauberzeug/nicegui-highcharts/>`_
30-
and can be installed with `pip install nicegui[highcharts]`.
29+
and can be installed with ``pip install nicegui[highcharts]``.
3130
32-
By default, a `Highcharts.chart` is created.
33-
To use, e.g., `Highcharts.stockChart` instead, set the `type` property to "stockChart".
31+
By default, a ``Highcharts.chart`` is created.
32+
To use, e.g., ``Highcharts.stockChart`` instead, set the ``type`` property to "stockChart".
3433
3534
:param options: dictionary of Highcharts options
3635
:param type: chart type (e.g. "chart", "stockChart", "mapChart", ...; default: "chart")

0 commit comments

Comments
 (0)