This is an automated email from the ASF dual-hosted git repository.
husseinawala pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new 9782ee3bbc Fix parameter syntax in Amazon docstrings (#35349)
9782ee3bbc is described below
commit 9782ee3bbc32384d4563831b84dc1fa889317fe8
Author: Josh Fell <48934154+josh-f...@users.noreply.github.com>
AuthorDate: Wed Nov 1 12:35:59 2023 -0400
Fix parameter syntax in Amazon docstrings (#35349)
In some of the classes and functions for the Amazon provider, there is an
extra colon present when specifying parameters in docstrings. This was causing
the parameters to not render correctly in API documentation.
---
airflow/providers/amazon/aws/notifications/chime.py | 6 +++---
airflow/providers/amazon/aws/operators/emr.py | 4 ++--
2 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/airflow/providers/amazon/aws/notifications/chime.py
b/airflow/providers/amazon/aws/notifications/chime.py
index 801666f772..7a8509541f 100644
--- a/airflow/providers/amazon/aws/notifications/chime.py
+++ b/airflow/providers/amazon/aws/notifications/chime.py
@@ -38,9 +38,9 @@ class ChimeNotifier(BaseNotifier):
"""
Chime notifier to send messages to a chime room via callbacks.
- :param: chime_conn_id: The chime connection to use with Endpoint as
"https://hooks.chime.aws"; and
- the webhook token in the form of
```{webhook.id}?token{webhook.token}```
- :param: message: The message to send to the chime room associated with the
webhook.
+ :param chime_conn_id: The chime connection to use with Endpoint as
"https://hooks.chime.aws"; and
+ the webhook token in the form of
```{webhook.id}?token{webhook.token}```
+ :param message: The message to send to the chime room associated with the
webhook.
"""
diff --git a/airflow/providers/amazon/aws/operators/emr.py
b/airflow/providers/amazon/aws/operators/emr.py
index d17e77c349..ea1ec0496a 100644
--- a/airflow/providers/amazon/aws/operators/emr.py
+++ b/airflow/providers/amazon/aws/operators/emr.py
@@ -205,9 +205,9 @@ class EmrStartNotebookExecutionOperator(BaseOperator):
:param notebook_execution_name: Optional name for the notebook execution.
:param notebook_params: Input parameters in JSON format passed to the EMR
notebook at
runtime for execution.
- :param: notebook_instance_security_group_id: The unique identifier of the
Amazon EC2
+ :param notebook_instance_security_group_id: The unique identifier of the
Amazon EC2
security group to associate with the EMR notebook for this notebook
execution.
- :param: master_instance_security_group_id: Optional unique ID of an EC2
security
+ :param master_instance_security_group_id: Optional unique ID of an EC2
security
group to associate with the master instance of the EMR cluster for
this notebook execution.
:param tags: Optional list of key value pair to associate with the
notebook execution.
:param waiter_max_attempts: Maximum number of tries before failing.
