comment (#3910)

comment comment
materialsproject · Jul 8, 2024 · 91e609c · 91e609c
1 parent 4a2c3df
commit 91e609c
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/pymatgen/analysis/local_env.py b/src/pymatgen/analysis/local_env.py
@@ -588,6 +588,10 @@ def get_bonded_structure(
         """
         Obtain a StructureGraph object using this NearNeighbor class. Requires pip install networkx.
 
+        NOTE: The StructureGraph will not contain sites or bonds that are equivalent under lattice
+        vector translations. For more details please see the following discussion:
+        https://github.com/materialsproject/pymatgen/issues/3888
+
         Args:
             structure: Structure object.
             decorate (bool): whether to annotate site properties with order parameters using neighbors