Skip to content

Commit 017d6ff

Browse files
authored
docs(get_field_shape): Correct docstring
2-element tuple, not a 3-element tuple. See usage in https://github.com/OpenPIV/openpiv-python/blob/7852c9fc5d4e6bb51da64df8e4f48407bd6e464e/openpiv/pyprocess.py#L986, which unpacks a 2-element tuple into 2 vars.
1 parent 7852c9f commit 017d6ff

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

openpiv/pyprocess.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ def get_field_shape(image_size, search_area_size, overlap):
5151
5252
Returns
5353
-------
54-
field_shape : three elements tuple
54+
field_shape : 2-element tuple
5555
the shape of the resulting flow field
5656
"""
5757
field_shape = (np.array(image_size) - np.array(search_area_size)) // (

0 commit comments

Comments
 (0)