Add better docblock for target (#23635)

## Summary & Motivation We added `target` to `sensor`, `SensorDefinition`, `schedule`, and `ScheduleDefinition` in 1.8 but documented it poorly. This adds a more fleshed out docblock. ## How I Tested These Changes Read. ![Screenshot 2024-08-13 at 3.51.09 PM.png](https://graphite-user-uploaded-assets-prod.s3.amazonaws.com/wS38mdcdU6aAeJobBdry/e19e5d8d-b270-4846-af51-d25c43ea41b2.png)
dagster-io · Aug 14, 2024 · 98b6737 · 98b6737 · github-actions · Aug 14, 2024
1 parent 170faf5
commit 98b6737
Show file tree

Hide file tree

Showing 8 changed files with 12 additions and 0 deletions.
diff --git a/docs/content/api/modules.json.gz b/docs/content/api/modules.json.gz
diff --git a/docs/content/api/searchindex.json.gz b/docs/content/api/searchindex.json.gz
diff --git a/docs/content/api/sections.json.gz b/docs/content/api/sections.json.gz
diff --git a/docs/next/public/objects.inv b/docs/next/public/objects.inv
diff --git a/python_modules/dagster/dagster/_core/definitions/decorators/schedule_decorator.py b/python_modules/dagster/dagster/_core/definitions/decorators/schedule_decorator.py
@@ -102,6 +102,9 @@ def schedule(
         required_resource_keys (Optional[Set[str]]): The set of resource keys required by the schedule.
         target (Optional[Union[CoercibleToAssetSelection, AssetsDefinition, JobDefinition, UnresolvedAssetJobDefinition]]):
             The target that the schedule will execute.
+            It can take :py:class:`~dagster.AssetSelection` objects and anything coercible to it (e.g. `str`, `Sequence[str]`, `AssetKey`, `AssetsDefinition`).
+            It can also accept :py:class:`~dagster.JobDefinition` (a function decorated with `@job` is an instance of `JobDefinition`) and `UnresolvedAssetJobDefinition` (the return value of :py:func:`~dagster.define_asset_job`) objects.
+            This is an experimental parameter that will replace `job` and `job_name`.
     """
 
     def inner(fn: RawScheduleEvaluationFunction) -> ScheduleDefinition:

diff --git a/python_modules/dagster/dagster/_core/definitions/decorators/sensor_decorator.py b/python_modules/dagster/dagster/_core/definitions/decorators/sensor_decorator.py
@@ -83,6 +83,9 @@ def sensor(
             This can be provided instead of specifying a job.
         target (Optional[Union[CoercibleToAssetSelection, AssetsDefinition, JobDefinition, UnresolvedAssetJobDefinition]]):
             The target that the sensor will execute.
+            It can take :py:class:`~dagster.AssetSelection` objects and anything coercible to it (e.g. `str`, `Sequence[str]`, `AssetKey`, `AssetsDefinition`).
+            It can also accept :py:class:`~dagster.JobDefinition` (a function decorated with `@job` is an instance of `JobDefinition`) and `UnresolvedAssetJobDefinition` (the return value of :py:func:`~dagster.define_asset_job`) objects.
+            This is an experimental parameter that will replace `job`, `jobs`, and `asset_selection`.
     """
     check.opt_str_param(name, "name")
 

diff --git a/python_modules/dagster/dagster/_core/definitions/schedule_definition.py b/python_modules/dagster/dagster/_core/definitions/schedule_definition.py
@@ -524,6 +524,9 @@ class ScheduleDefinition(IHasInternalInit):
         required_resource_keys (Optional[Set[str]]): The set of resource keys required by the schedule.
         target (Optional[Union[CoercibleToAssetSelection, AssetsDefinition, JobDefinition, UnresolvedAssetJobDefinition]]):
             The target that the schedule will execute.
+            It can take :py:class:`~dagster.AssetSelection` objects and anything coercible to it (e.g. `str`, `Sequence[str]`, `AssetKey`, `AssetsDefinition`).
+            It can also accept :py:class:`~dagster.JobDefinition` (a function decorated with `@job` is an instance of `JobDefinition`) and `UnresolvedAssetJobDefinition` (the return value of :py:func:`~dagster.define_asset_job`) objects.
+            This is an experimental parameter that will replace `job` and `job_name`.
     """
 
     def with_updated_job(self, new_job: ExecutableDefinition) -> "ScheduleDefinition":

diff --git a/python_modules/dagster/dagster/_core/definitions/sensor_definition.py b/python_modules/dagster/dagster/_core/definitions/sensor_definition.py
@@ -570,6 +570,9 @@ class SensorDefinition(IHasInternalInit):
             This can be provided instead of specifying a job.
         target (Optional[Union[CoercibleToAssetSelection, AssetsDefinition, JobDefinition, UnresolvedAssetJobDefinition]]):
             The target that the sensor will execute.
+            It can take :py:class:`~dagster.AssetSelection` objects and anything coercible to it (e.g. `str`, `Sequence[str]`, `AssetKey`, `AssetsDefinition`).
+            It can also accept :py:class:`~dagster.JobDefinition` (a function decorated with `@job` is an instance of `JobDefinition`) and `UnresolvedAssetJobDefinition` (the return value of :py:func:`~dagster.define_asset_job`) objects.
+            This is an experimental parameter that will replace `job`, `jobs`, and `asset_selection`.
     """
 
     def with_updated_jobs(self, new_jobs: Sequence[ExecutableDefinition]) -> "SensorDefinition":