Skip to content

Commit

Permalink
added doc note to _orbital_values
Browse files Browse the repository at this point in the history
Signed-off-by: Nick Papior <[email protected]>
  • Loading branch information
zerothi committed Jun 19, 2024
1 parent c0986ad commit 718b7ab
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/sisl/_core/geometry.py
Original file line number Diff line number Diff line change
Expand Up @@ -3618,6 +3618,10 @@ def _orbital_values(self, grid_shape: Tuple[int, int, int]):
----------
grid_shape:
the grid shape (i.e. resolution) in which to calculate the orbital values.
Notes
-----
This method does not belong on this geometry. It will be removed eventually.
"""
# We need to import these here to avoid circular imports.
from sisl import Grid
Expand Down

0 comments on commit 718b7ab

Please sign in to comment.