From 4099bd1991e1cff64ab47b21c6e71af0418547f2 Mon Sep 17 00:00:00 2001
From: lochhh <changhuan.lo@ucl.ac.uk>
Date: Tue, 29 Oct 2024 11:54:04 +0000
Subject: [PATCH] Update docstrings
---
movement/kinematics.py | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/movement/kinematics.py b/movement/kinematics.py
index 2cf451444..53de27bbc 100644
--- a/movement/kinematics.py
+++ b/movement/kinematics.py
@@ -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"``.
@@ -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