correct/update docs and parameter names for finding neighbor lists

2021-04-02 19:55:53 -04:00
parent 5583901b2c
commit 51212e62d9
2 changed files with 43 additions and 23 deletions
--- a/python/lammps/data.py
+++ b/python/lammps/data.py
@ -52,7 +52,7 @@ class NeighList:

    def get(self, element):
        """
-        :return: tuple with atom local index, numpy array of neighbor local atom indices
+        :return: tuple with atom local index, number of neighbors and ctypes pointer to neighbor's local atom indices
        :rtype:  (int, int, ctypes.POINTER(c_int))
        """
        iatom, numneigh, neighbors = self.lmp.get_neighlist_element_neighbors(self.idx, element)