Skip to content

Commit 006adc5

Browse files
correction for documentation
1 parent b5c3101 commit 006adc5

File tree

3 files changed

+7
-5
lines changed

3 files changed

+7
-5
lines changed

src/py_eddy_tracker/generic.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,9 @@ def build_index(groups):
7070
:param array groups: array that contains groups to be separated
7171
:return: (first_index of each group, last_index of each group, value to shift groups)
7272
:rtype: (array, array, int)
73-
Examples
74-
--------
73+
74+
:Example:
75+
7576
>>> build_index(array((1, 1, 3, 4, 4)))
7677
(array([0, 2, 2, 3]), array([2, 2, 3, 5]), 1)
7778
"""

src/py_eddy_tracker/observations/network.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ def from_split_network(cls, group_dataset, indexs, **kwargs):
221221
222222
:param TrackEddiesObservations group_dataset: Group dataset
223223
:param indexs: result from split_network
224-
return NetworkObservations
224+
:return: NetworkObservations
225225
"""
226226
index_order = indexs.argsort(order=("group", "track", "time"))
227227
network = cls.new_like(group_dataset, len(group_dataset), **kwargs)
@@ -1598,8 +1598,8 @@ def group_translator(nb, duos):
15981598
:param int nb: size of translator
15991599
:param set((int, int)) duos: set of all groups that must be joined
16001600
1601-
Examples
1602-
--------
1601+
:Example:
1602+
16031603
>>> NetworkObservations.group_translator(5, ((0, 1), (0, 2), (1, 3)))
16041604
[3, 3, 3, 3, 5]
16051605
"""

src/py_eddy_tracker/poly.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -717,6 +717,7 @@ def visvalingam(x, y, fixed_size=18):
717717
"""Polygon simplification with visvalingam algorithm
718718
719719
X, Y are considered like a polygon, the next point after the last one is the first one
720+
720721
:param array x:
721722
:param array y:
722723
:param int fixed_size: array size of out

0 commit comments

Comments
 (0)