docstrings are my nemesis

esoteric-ephemera · esoteric-ephemera · commit 0b8f40dd9e22 · 2024-01-16T16:36:01.000-08:00
diff --git a/pymatgen/io/validation/check_incar.py b/pymatgen/io/validation/check_incar.py
@@ -701,6 +701,8 @@ def _check_u_params(reasons, incar, parameters, valid_input_set):
 
 
 class BaseValidator:
+    """Lightweight validator class to handle majority of parameter checking."""
+
     input_tag_translation = {"ENMAX": "ENCUT"}
 
     operations = {
