Skip to content

Incorrect docstring for apply_wildcard parameter in S3ListOperator #36593

@simond

Description

@simond

What do you see as an issue?

The docstring for the S3ListOperator is incorrect for the apply_wildcard parameter:

:param apply_wildcard: whether to treat '*' as a wildcard or a plain symbol in the prefix.
        By default SSL certificates are verified.
        You can provide the following values:


        - ``False``: do not validate SSL certificates. SSL will still be used
                 (unless use_ssl is False), but SSL certificates will not be
                 verified.
        - ``path/to/cert/bundle.pem``: A filename of the CA cert bundle to uses.
                 You can specify this argument if you want to use a different
                 CA cert bundle than the one used by botocore.

Solving the problem

It looks as though most of the docstring should actually be part of the verify and not the apply_wildcard one. Moving the following lines up under the verify parameter should resolve:

        By default SSL certificates are verified.
        You can provide the following values:


        - ``False``: do not validate SSL certificates. SSL will still be used
                 (unless use_ssl is False), but SSL certificates will not be
                 verified.
        - ``path/to/cert/bundle.pem``: A filename of the CA cert bundle to uses.
                 You can specify this argument if you want to use a different
                 CA cert bundle than the one used by botocore.

Anything else

No response

Are you willing to submit PR?

  • Yes I am willing to submit a PR!

Code of Conduct

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions