Document the usage of NoDataError in it's docstring (#4359)

* document the usage of NoDataError in docstring --------- Co-authored-by: Lily Wang <[email protected]>
MDAnalysis · Dec 12, 2023 · ad40922 · ad40922
1 parent 6179b2b
commit ad40922
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 1 deletion.
diff --git a/package/AUTHORS b/package/AUTHORS
@@ -223,6 +223,7 @@ Chronological list of authors
   - Zaheer Timol
   - Geongi Moon
   - Sumit Gupta
+  - Heet Vekariya
 
 External code
 -------------

diff --git a/package/CHANGELOG b/package/CHANGELOG
@@ -15,7 +15,7 @@ The rules for this file:
 
 -------------------------------------------------------------------------------
 ??/??/?? IAlibay, ianmkenney, PicoCentauri, pgbarletta, p-j-smith, 
-         richardjgowers, lilyminium, ALescoulie, hmacdope
+         richardjgowers, lilyminium, ALescoulie, hmacdope, HeetVekariya
 
  * 2.7.0
 
@@ -31,6 +31,7 @@ Fixes
   * Fix atom charge reading in PDBQT parser (Issue #4282, PR #4283)
 
 Enhancements
+  * Document the usage of NoDataError in its docstring (Issue #3901, PR #4359)
   * Refactor c_distances backend to have a cython .pxd header and expose in
     libmdanalysis (Issue #4315, PR #4324)
   * Add faster nucleic acid Major and Minor pair distance calculators using

diff --git a/package/MDAnalysis/exceptions.py b/package/MDAnalysis/exceptions.py
@@ -35,6 +35,24 @@ class SelectionError(Exception):
 class NoDataError(ValueError, AttributeError):
     """Raised when empty input is not allowed or required data are missing.
 
+    This exception is raised in the following scenarios:
+
+    * Raised when a :class:`~MDAnalysis.core.topologyattrs.TopologyAttr`
+      (e.g., bonds, charges) is not present in the data.
+
+    * Raised when data is missing in an analysis class because the `run()`
+      method has not been called, e.g.
+      :class:`~MDAnalysis.analysis.polymer.PersistenceLength`.
+
+    * Raised when timestep data is missing, such as positions, velocities,
+      or forces.
+
+    * Raised in the `nojump` transformation if there is no box information
+      in the universe.
+
+    This exception should not be raised in cases where arrays have zero width,
+    or AtomGroups are empty.
+
     .. versionchanged:: 1.0.0
         Now a subclass of AttributeError as well as ValueError
     """