Docs warning for charge in DielectricConstant (#4263)

* Docs warning for charge in DielectricConstant
MDAnalysis · Sep 2, 2023 · c2e6df9 · c2e6df9
1 parent e3354d1
commit c2e6df9
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,7 +13,7 @@ The rules for this file:
   * release numbers follow "Semantic Versioning" http://semver.org
 
 ------------------------------------------------------------------------------
-??/??/?? IAlibay, ianmkenney
+??/??/?? IAlibay, ianmkenney, PicoCentauri
 
  * 2.7.0
 
@@ -22,6 +22,8 @@ Fixes
     their original type value (np.float64 and np.nan) (PR #4272)
 
 Enhancements
+  * Added a warning about charge neutrality to the documentation of
+    `DielectricConstant` (Issue #4262, PR #4263)
 
 Changes
   * The `mda-xdrlib` module is now a core dependency of MDAnalysis

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