Add docblock for SensorResult.asset_events (#16705)

## Summary & Motivation Since we are putting an experimental param on a publicly exporting class, we should document it. ## How I Tested These Changes BK --------- Co-authored-by: Yuhan Luo <[email protected]>
dagster-io · Sep 26, 2023 · ad95c8a · ad95c8a · github-actions · Sep 26, 2023
1 parent ce270a8
commit ad95c8a
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 3 deletions.
diff --git a/docs/content/api/modules.json b/docs/content/api/modules.json
diff --git a/docs/content/api/searchindex.json b/docs/content/api/searchindex.json
diff --git a/docs/content/api/sections.json b/docs/content/api/sections.json
diff --git a/docs/next/public/objects.inv b/docs/next/public/objects.inv
diff --git a/python_modules/dagster/dagster/_core/definitions/run_request.py b/python_modules/dagster/dagster/_core/definitions/run_request.py
@@ -387,6 +387,12 @@ class SensorResult(
             AddDynamicPartitionsRequest]]]): A list of dynamic partition requests to request dynamic
             partition addition and deletion. Run requests will be evaluated using the state of the
             partitions with these changes applied.
+        asset_events (Optional[Sequence[Union[AssetObservation, AssetMaterialization, AssetCheckEvaluation]]]):  (Experimental) A
+            list of materializations, observations, and asset check evaluations that the system
+            will persist on your behalf at the end of sensor evaluation. These events will be not
+            be associated with any particular run, but will be queryable and viewable in the asset catalog.
+
+
     """
 
     def __new__(