amepproject / amep

The Active Matter Evaluation Package (AMEP) - a Python library for the analysis of particle-based and continuum simulation data of soft and active matter systems
https://amepproject.de/
GNU General Public License v3.0
12 stars 2 forks source link

DOC: Incorrect description of 'coords' and 'other_coords' in 'order.nearest_neighbors' and 'order.k_nearest_neighbors' #39

Closed aritra-mukhopadhyay closed 1 month ago

aritra-mukhopadhyay commented 5 months ago

Problem description:

These two descriptions should be interchanged:

coords (np.ndarray of shape (N,3)) – Array of coordinates/points to search for neighbors.

other_coords (np.ndarray of shape (M,3) or None, optional) – Array of points to search for neighbors of. The default is None (use coords).

Suggested content improvement:

Should read:

coords (np.ndarray of shape (N,3)) – Array of points to search for neighbors of.

other_coords (np.ndarray of shape (M,3) or None, optional) – Array of coordinates/points to search for neighbors. The default is None (use coords).