Skip to content

Commit c642388

Browse files
committed
Add more detail to docstring
1 parent 79cbb5c commit c642388

1 file changed

Lines changed: 7 additions & 4 deletions

File tree

folium/plugins/fast_marker_cluster.py

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,13 @@ class FastMarkerCluster(MarkerCluster):
1616
def __init__(self, data, callback=None):
1717
"""Add marker clusters to a map using in-browser rendering.
1818
Using FastMarkerCluster it is possible to render 000's of
19-
points far quicker than the MarkerCluster class. Be aware
20-
that the FastMarkerCluster class does not retain a
21-
reference to any marker data, and therefore methods such as
22-
get_bounds() are not available when using it.
19+
points far quicker than the MarkerCluster class.
20+
21+
Be aware that the FastMarkerCluster class passes an empty
22+
list to the parent class' __init__ method during initialisation.
23+
This means that the add_child method is never called, and
24+
no reference to any marker data are retained. Methids such
25+
as get_bounds() are therefore not available when using it.
2326
2427
Parameters
2528
----------

0 commit comments

Comments
 (0)