Skip to content

Comments

Correct parameter names in docstring for S3CreateObjectOperator#34263

Merged
vincbeck merged 2 commits intoapache:mainfrom
mjsqu:patch-1
Sep 11, 2023
Merged

Correct parameter names in docstring for S3CreateObjectOperator#34263
vincbeck merged 2 commits intoapache:mainfrom
mjsqu:patch-1

Conversation

@mjsqu
Copy link
Contributor

@mjsqu mjsqu commented Sep 11, 2023

Currently the parameter descriptions for S3CreateObjectOperator reference old(?) parameter names:

s3_bucket (str | None) – Name of the S3 bucket where to save the object. (templated) It should be omitted when bucket_key s3_key is provided as a full s3:// url.

s3_key (str) – The key of the object to be created. (templated) It can be either full s3:// style url or relative path from root level. When it’s specified as a full s3:// url, please omit bucket_name s3_bucket.


^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

Currently the parameter descriptions for `S3CreateObjectOperator` reference old(?) parameter names:

> s3_bucket (str | None) – Name of the S3 bucket where to save the object. (templated) It should be omitted when ~~bucket_key~~ **s3_key** is provided as a full s3:// url.

> s3_key (str) – The key of the object to be created. (templated) It can be either full s3:// style url or relative path from root level. When it’s specified as a full s3:// url, please omit ~~bucket_name~~ **s3_bucket**.
@boring-cyborg boring-cyborg bot added area:providers provider:amazon AWS/Amazon - related issues labels Sep 11, 2023
Co-authored-by: Tzu-ping Chung <uranusjr@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:providers provider:amazon AWS/Amazon - related issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants