infer resource descriptions from docstrings (#7309)

dagster-io · Apr 12, 2022 · 0ba3b4e · 0ba3b4e
1 parent 104e780
commit 0ba3b4e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/python_modules/dagster/dagster/core/definitions/resource_definition.py b/python_modules/dagster/dagster/core/definitions/resource_definition.py
@@ -16,6 +16,7 @@
 )
 
 from dagster import check
+from dagster.core.decorator_utils import format_docstring_for_description
 from dagster.core.definitions.config import is_callable_valid_config_arg
 from dagster.core.definitions.configurable import AnonymousConfigurableDefinition
 from dagster.core.errors import (
@@ -252,7 +253,7 @@ def __call__(self, resource_fn: Callable[["InitResourceContext"], Any]):
         resource_def = ResourceDefinition(
             resource_fn=resource_fn,
             config_schema=self.config_schema,
-            description=self.description,
+            description=self.description or format_docstring_for_description(resource_fn),
             version=self.version,
             required_resource_keys=self.required_resource_keys,
         )

diff --git a/...dagster_tests/core_tests/definitions_tests/decorators_tests/test_description_inference.py b/...dagster_tests/core_tests/definitions_tests/decorators_tests/test_description_inference.py
@@ -1,8 +1,8 @@
-from dagster import composite_solid, graph, job, op, solid
+from dagster import composite_solid, graph, job, op, resource, solid
 
 
 def test_description_inference():
-    decorators = [job, op, graph, solid, composite_solid]
+    decorators = [job, op, graph, solid, composite_solid, resource]
     for decorator in decorators:
 
         @decorator