Documentation of ``intersect_edges`` not up to date

[JoerivanEngelen]

At present, it is stated that the method intersect_edges returns the following three things:

• edge_indices (ndarray of integers with shape (n_found,)) – Indices of the bounding box.
• tree_face_indices (ndarray of integers with shape (n_found,)) – Indices of the face.
• length (ndarray of floats with shape (n_found,)) – Length of intersection of the edge inside of the face.

See docs here

However, when debugging the code xugrid, I noticed that the third array returned, has the shape of (n_found, 2, 2). This is by definition.

It thus seemed to me like it is not returning a length anymore, but pairs of points? In the xugrid code this is called intersection_edges. See code in xugrid.