Skip to content

Commit

Permalink
Fix parameter syntax in Amazon docstrings (#35349)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
josh-fell authored Nov 1, 2023
1 parent 9e2f1ce commit 9782ee3
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions airflow/providers/amazon/aws/notifications/chime.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""

Expand Down
4 changes: 2 additions & 2 deletions airflow/providers/amazon/aws/operators/emr.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 9782ee3

Please sign in to comment.