Skip to content

Commit

Permalink
Fix docstring formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
lochhh committed Sep 10, 2024
1 parent 0698ced commit cde47d5
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion movement/analysis/kinematics.py
Original file line number Diff line number Diff line change
Expand Up @@ -424,16 +424,17 @@ def compute_interkeypoint_distances(
* key1 (key1) <U4 32B 'ind1' 'ind2'
* key2 (key2) <U4 32B 'ind1' 'ind2'
The resulting ``dist_key1_key2`` is a DataArray containing the computed
distances between ``key1`` and ``key2`` for all individuals
at each time point.
To obtain the distances between ``key1`` and ``key2`` within ``ind1``:
>>> dist_key1_key2.sel(key1="ind1", key2="ind1")
To obtain the distances between ``key1`` of ``ind1`` and
``key2`` of ``ind2``:
>>> dist_key1_key2.sel(key1="ind1", key2="ind2")
Compute the city block or Manhattan distance for multiple pairs of
Expand Down

0 comments on commit cde47d5

Please sign in to comment.