Skip to content

Commit 1ac2762

Browse files
committed
add docstrings
1 parent e8313bb commit 1ac2762

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

uxarray/grid/connectivity.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -456,7 +456,10 @@ def _build_face_face_connectivity(grid):
456456

457457

458458
def _populate_node_edge_connectivity(grid):
459-
node_edge_connectivity = _build_node_edge_connectivity_numba(
459+
"""Constructs the UGRID connectivity variable (``edge_node_connectivity``)
460+
and stores it within the internal (``Grid._ds``) and through the attribute
461+
(``Grid.edge_node_connectivity``)."""
462+
node_edge_connectivity = _build_node_edge_connectivity(
460463
grid.edge_node_connectivity.values, grid.n_node
461464
)
462465

@@ -468,8 +471,8 @@ def _populate_node_edge_connectivity(grid):
468471

469472

470473
@njit
471-
def _build_node_edge_connectivity_numba(edge_nodes, n_node):
472-
"""TODO:"""
474+
def _build_node_edge_connectivity(edge_nodes, n_node):
475+
"""Constructs the Node Edge Connectivity, which stores the indices of the edges that are shared by each node."""
473476
n_edge, nodes_per_edge = edge_nodes.shape
474477

475478
# count how many edges touch each node

0 commit comments

Comments
 (0)