Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HydroShare::search outdated docstring #16

Open
aaraney opened this issue Jul 12, 2021 · 0 comments
Open

HydroShare::search outdated docstring #16

aaraney opened this issue Jul 12, 2021 · 0 comments

Comments

@aaraney
Copy link
Member

aaraney commented Jul 12, 2021

The keyword argument resource_types is referred to as types in the docstring (see below). I'll submit a PR to resolve this, but just wanted to document it.

def search(
        ...,
        resource_types: List[str] = [],
        ...
    ):
        """
        ...
        :param types: Filter results to particular HydroShare resource types (Deprecated, all types are Composite)
        ...
        """

:param types: Filter results to particular HydroShare resource types (Deprecated, all types are Composite)

@sblack-usu, given the context you added to the docstring, should a deprecated warning be raised if resource_types is passed? If so, Ill include that in the PR as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant