Ensure that workflow description is used in documentation

Author: larsevj

src/ert/config/workflow_job.py

@@ -194,8 +194,6 @@ def validate_types(self) -> Self:
                 f"Failed to load {self.name}, script had wrong "
                 f"type, expected ErtScript, got {ertscript_class}"
             )
-        if ertscript_class.__doc__:
-            self.description = textwrap.dedent(ertscript_class.__doc__.strip())
         return self
 
     @property
@@ -227,6 +225,12 @@ def serialize_model(self) -> _SerializedSiteInstalledErtScriptWorkflow:
     def load_ert_script_class(self) -> builtins.type[ErtScript]:
         return self.ert_script
 
+    @model_validator(mode="after")
+    def set_default_description(self) -> Self:
+        if not self.description and self.ert_script.__doc__:
+            self.description = textwrap.dedent(self.ert_script.__doc__.strip())
+        return self
+
     @model_validator(mode="before")
     @classmethod
     def deserialize_model(

tests/ert/unit_tests/plugins/test_workflow_config.py

@@ -72,6 +72,22 @@ class MockedErtScript(ErtScript):
     assert configs.get_workflows()["MockedErtScript"].description == "description"
 
 
+def test_that_explicit_workflow_description_takes_precedence_over_ertscript_docstring():
+    class MockedErtScript(ErtScript):
+        """Class docstring."""
+
+    configs = workflow_config.WorkflowConfigs()
+    configs.add_workflow(
+        ert_script=MockedErtScript,
+        description="Explicit description.",
+    )
+
+    assert (
+        configs.get_workflows()["MockedErtScript"].description
+        == "Explicit description."
+    )
+
+
 @pytest.mark.filterwarnings("ignore:Use of legacy_ertscript_workflow is deprecated")
 def test_legacy_workflow_config_can_set_description_through_parameter():
     class MockedErtScript(ErtScript):