Update to average Grüneisen documenation (materialsproject#3773)

* Update gruneisen.py * Update pymatgen/phonon/gruneisen.py Signed-off-by: J. George <[email protected]> --------- Signed-off-by: J. George <[email protected]>
ab5424 · Apr 19, 2024 · 666e1d7 · 666e1d7
1 parent 2d008e0
commit 666e1d7
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/pymatgen/phonon/gruneisen.py b/pymatgen/phonon/gruneisen.py
@@ -75,10 +75,10 @@ def average_gruneisen(
         limit_frequencies: Literal["debye", "acoustic"] | None = None,
     ) -> float:
         """Calculates the average of the Gruneisen based on the values on the regular grid.
-        If squared is True the average will use the squared value of the Gruneisen and a squared root
+        If squared is True, the average will use the squared value of the Gruneisen and a squared root
         is performed on the final result.
-        Values associated to negative frequencies will be ignored.
-        See Scripta Materialia 129, 88 for definitions.
+        Values associated with negative frequencies will be ignored.
+        See Nath et al. _Scripta Materialia_ **2017**, _129_, 88 for the definitions.
         Adapted from classes in abipy that have been written by Guido Petretto (UCLouvain).
 
         Args: