hydroshare / hsclient

A python client for interacting with HydroShare in an object oriented way.

Home Page:https://hydroshare.github.io/hsclient/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

HydroShare::search outdated docstring

aaraney opened this issue · comments

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.