From ef21f56b1f3354c8e2ca1986df493f3ee1a8207c Mon Sep 17 00:00:00 2001
From: "Adam M. Krajewski" <54290107+amkrajewski@users.noreply.github.com>
Date: Sun, 17 Mar 2024 21:55:24 -0400
Subject: [PATCH] (docs) improved `ward2ks2022` conversion description

---
 pysipfenn/core/pysipfenn.py | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/pysipfenn/core/pysipfenn.py b/pysipfenn/core/pysipfenn.py
index 349242d..4b75391 100644
--- a/pysipfenn/core/pysipfenn.py
+++ b/pysipfenn/core/pysipfenn.py
@@ -1102,7 +1102,11 @@ def destroy(self) -> None:
 # ************************  SATELLITE FUNCTIONS  ************************
             
 def ward2ks2022(ward2017: np.ndarray) -> np.ndarray:
-    """Converts a ``Ward2017`` descriptor to a ``KS2022`` descriptor (which is its subset).
+    """Converts a ``Ward2017`` descriptor to a ``KS2022`` descriptor (which is its subset). It removes: `mean_WCMagnitude_Shell1`, `mean_WCMagnitude_Shell2`, 
+    `mean_WCMagnitude_Shell3`, `mean_NeighDiff_shell1_SpaceGroupNumber`, `var_NeighDiff_shell1_SpaceGroupNumber`, `min_NeighDiff_shell1_SpaceGroupNumber`, 
+    `max_NeighDiff_shell1_SpaceGroupNumber`, `range_NeighDiff_shell1_SpaceGroupNumber`, `mean_SpaceGroupNumber`, `maxdiff_SpaceGroupNumber`, 
+    `dev_SpaceGroupNumber`, `max_SpaceGroupNumber`, `min_SpaceGroupNumber`, `most_SpaceGroupNumber`, and `CanFormIonic`, for physicality and performance 
+    improvements.
 
     Args:
         ward2017: ``Ward2017`` descriptor. Must be a 1D ``np.ndarray`` of length ``271``.