Improve docstring, default kwarg for get_bonded_structure

materialsproject · Jul 6, 2019 · f1b9318 · f1b9318
1 parent 7094d07
commit f1b9318
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/pymatgen/analysis/local_env.py b/pymatgen/analysis/local_env.py
@@ -515,7 +515,7 @@ def _get_original_site(structure, site):
                 return i
         raise Exception('Site not found!')
 
-    def get_bonded_structure(self, structure, decorate=False):
+    def get_bonded_structure(self, structure, decorate=False, weights=True):
         """
         Obtain a StructureGraph object using this NearNeighbor
         class. Requires the optional dependency networkx
@@ -526,8 +526,10 @@ def get_bonded_structure(self, structure, decorate=False):
             decorate (bool): whether to annotate site properties
             with order parameters using neighbors determined by
             this NearNeighbor class
+            weights (bool): whether to include edge weights from
+            NearNeighbor class in StructureGraph
 
-        Returns: a pymatgen.analysis.graphs.BondedStructure object
+        Returns: a pymatgen.analysis.graphs.StructureGraph object
         """
 
         # requires optional dependency which is why it's not a top-level import
@@ -542,7 +544,7 @@ def get_bonded_structure(self, structure, decorate=False):
                                 for n in range(len(structure))]
             structure.add_site_property('order_parameters', order_parameters)
 
-        sg = StructureGraph.with_local_env_strategy(structure, self, weights=True)
+        sg = StructureGraph.with_local_env_strategy(structure, self, weights=weights)
 
         return sg