[ 
https://issues.apache.org/jira/browse/AIRFLOW-2292?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16429833#comment-16429833
 ] 

ASF subversion and git services commented on AIRFLOW-2292:
----------------------------------------------------------

Commit a5943a14256a2f9dbd38e539ebc524d19dfef214 in incubator-airflow's branch 
refs/heads/master from [~sekikn]
[ https://git-wip-us.apache.org/repos/asf?p=incubator-airflow.git;h=a5943a1 ]

[AIRFLOW-2292] Fix docstring for S3Hook.get_wildcard_key

Fix a misleading description and wrong parameter
names
in S3Hook.get_wildcard_key's docstring.

Closes #3196 from sekikn/AIRFLOW-2292


> Fix docstring for S3Hook.get_wildcard_key
> -----------------------------------------
>
>                 Key: AIRFLOW-2292
>                 URL: https://issues.apache.org/jira/browse/AIRFLOW-2292
>             Project: Apache Airflow
>          Issue Type: Bug
>          Components: docs, Documentation
>            Reporter: Kengo Seki
>            Assignee: Kengo Seki
>            Priority: Minor
>             Fix For: 2.0.0
>
>
> S3Hook.get_wildcard_key's docstring says as follows, but the right name is 
> {{wildcard_key}}. It's doubly misleading since the pattern must be specified 
> as glob, not regex.
> {code:python}
>     def get_wildcard_key(self, wildcard_key, bucket_name=None, delimiter=''):
>         """
>         Returns a boto3.s3.Object object matching the regular expression
>         :param regex_key: the path to the key
>         :type regex_key: str
> {code}



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Reply via email to