Skip to content

Commit

Permalink
Update docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
lochhh committed Oct 29, 2024
1 parent 19d6fa2 commit 4099bd1
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions movement/kinematics.py
Original file line number Diff line number Diff line change
Expand Up @@ -447,7 +447,7 @@ def compute_pairwise_distances(
dim : Literal["individuals", "keypoints"]
The dimension to compute the distances for. Must be either
``'individuals'`` or ``'keypoints'``.
pairs : dict[str, str | list[str]] | Literal["all"]
pairs : dict[str, str | list[str]] or Literal["all"]
A dictionary containing the mapping between pairs of ``individuals``
or ``keypoints``, or the special keyword ``"all"``.
Expand All @@ -469,7 +469,7 @@ def compute_pairwise_distances(
Returns
-------
xarray.DataArray | dict[str, xarray.DataArray]
xarray.DataArray or dict[str, xarray.DataArray]
An :class:`xarray.DataArray` containing the computed distances between
a single pair of ``individuals`` or ``keypoints``. If multiple
``pairs`` are provided, this will be a dictionary containing the
Expand Down

0 comments on commit 4099bd1

Please sign in to comment.