Skip to content

Commit 73c0d24

Browse files
authored
Remove a few stray :types in docs (#21014)
I also noticed a couple of `:rtype` that should have been `:type` so I've removed those too. Sadly we can't remove `:rtype` en-mass yet as Sphinx doesn't pick up the return type from type hints.
1 parent 30c3d02 commit 73c0d24

File tree

7 files changed

+0
-10
lines changed

7 files changed

+0
-10
lines changed

β€Žairflow/dag_processing/manager.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,6 @@ class DagFileProcessorAgent(LoggingMixin, MultiprocessingStartMethodMixin):
9999
:param processor_timeout: How long to wait before timing out a DAG file processor
100100
:param dag_ids: if specified, only schedule tasks with these DAG IDs
101101
:param pickle_dags: whether to pickle DAGs.
102-
:type: pickle_dags: bool
103102
:param async_mode: Whether to start agent in async mode
104103
"""
105104

β€Žairflow/models/baseoperator.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1412,7 +1412,6 @@ def xcom_push(
14121412
Make an XCom available for tasks to pull.
14131413
14141414
:param context: Execution Context Dictionary
1415-
:type: Any
14161415
:param key: A key for the XCom
14171416
:param value: A value for the XCom. The value is pickled and stored
14181417
in the database.
@@ -1443,7 +1442,6 @@ def xcom_pull(
14431442
whenever no matches are found.
14441443
14451444
:param context: Execution Context Dictionary
1446-
:type: Any
14471445
:param key: A key for the XCom. If provided, only XComs with matching
14481446
keys will be returned. The default key is 'return_value', also
14491447
available as a constant XCOM_RETURN_KEY. This key is automatically

β€Žairflow/models/sensorinstance.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,6 @@ def register(cls, ti, poke_context, execution_context, session=None):
9696
context used for a sensor and set the sensor_instance table state to sensing.
9797
9898
:param ti: The task instance for the sensor to be registered.
99-
:type: ti:
10099
:param poke_context: Context used for sensor poke function.
101100
:param execution_context: Context used for execute sensor such as timeout
102101
setting and email configuration.

β€Žairflow/providers/alibaba/cloud/hooks/oss.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,7 @@ def parse_oss_url(ossurl: str) -> tuple:
105105
Parses the OSS Url into a bucket name and key.
106106
107107
:param ossurl: The OSS Url to parse.
108-
:rtype ossurl: str
109108
:return: the parsed bucket name and key
110-
:rtype: tuple of str
111109
"""
112110
parsed_url = urlparse(ossurl)
113111

β€Žairflow/providers/amazon/aws/operators/cloud_formation.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,6 @@ class CloudFormationDeleteStackOperator(BaseOperator):
6565
6666
.. seealso::
6767
https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cloudformation.html#CloudFormation.Client.delete_stack
68-
:type cloudformation_parameters: dict
6968
:param aws_conn_id: aws connection to uses
7069
"""
7170

β€Žairflow/providers/google/cloud/hooks/cloud_storage_transfer_service.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,9 +108,7 @@ def gen_job_name(job_name: str) -> str:
108108
Suffix β€” current timestamp
109109
110110
:param job_name:
111-
:rtype job_name: str
112111
:return: job_name with suffix
113-
:rtype: str
114112
"""
115113
uniq = int(time.time())
116114
return f"{job_name}_{uniq}"

β€Žtests/providers/amazon/aws/utils/eks_test_utils.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,6 @@ def region_matches_partition(region: str, partition: str) -> bool:
153153
Returns True if the provided region and partition are a valid pair.
154154
155155
:param region: AWS region code to test.
156-
:type: region: str
157156
:param partition: AWS partition code to test.
158157
:return: Returns True if the provided region and partition are a valid pair.
159158
:rtype: bool

0 commit comments

Comments
 (0)