Docs warning for charge in DielectricConstant

MDAnalysis · Aug 28, 2023 · f266906 · f266906
1 parent d8107b6
commit f266906
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/package/CHANGELOG b/package/CHANGELOG
@@ -13,14 +13,16 @@ The rules for this file:
   * release numbers follow "Semantic Versioning" http://semver.org
 
 ------------------------------------------------------------------------------
-??/??/?? IAlibay, hmacdope, pillose, jaclark5, tylerjereddy
+??/??/?? IAlibay, hmacdope, pillose, jaclark5, tylerjereddy, PicoCentauri
 
  * 2.7.0
 
 Fixes
   * Fix Atom type guessing error (PR #4168, Issue #4167)
 
 Enhancements
+  * Added a warning about charge neutrality to the documentation of
+    ``DielectricConstant`` (Issue #4262, PR #4263)
 
 Changes
   * NumPy `in1d` replaced with `isin` in preparation for NumPy

diff --git a/package/MDAnalysis/analysis/dielectric.py b/package/MDAnalysis/analysis/dielectric.py
@@ -65,6 +65,10 @@ class DielectricConstant(AnalysisBase):
     the usual case if electrostatics are handled with a Ewald summation
     technique. See [Neumann1983]_ for details on the derivation.
 
+    .. warning::
+      Applying this class requires that no free charges, such as ions or
+      charged fragments, are present in the simulation.
+
     Parameters
     ----------
     atomgroup : MDAnalysis.core.groups.AtomGroup