improve healpix.pad docs

NVlabs · Dec 20, 2024 · efb891c · efb891c
1 parent c9cb58d
commit efb891c
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/earth2grid/healpix.py b/earth2grid/healpix.py
@@ -76,7 +76,8 @@ def pad(x: torch.Tensor, padding: int) -> torch.Tensor:
     Pad each face consistently with its according neighbors in the HEALPix
 
     Args:
-        x: The input tensor of shape [N, F, H, W] or [N, F, C, H, W]
+        x: The input tensor of shape [N, F, H, W] or [N, F, C, H, W]. Must be
+            ordered in HEALPIX_PAD_XY pixel ordering.
         padding: the amount of padding
 
     Returns: