diff --git a/eossr/api/__init__.py b/eossr/api/__init__.py index a3173d0b6d4fc842bc60cdfa94971f97df5e73b8..954b19027456e4df6564f8fb9b3a35e337288133 100644 --- a/eossr/api/__init__.py +++ b/eossr/api/__init__.py @@ -12,10 +12,11 @@ escape_community = 'escape2020' def get_ossr_records(search='', sandbox=False, **kwargs): """ - Retrieve all OSSR entries. - Potentially long when the number of records in the OSSR increases. + Search the OSSR for records whose names or descriptions include the provided string `search`. + Function rewritten from pyzenodo3 (https://github.com/space-physics/pyzenodo3) :param search: string + A string to refine the search in the OSSR. The default will search for all records in the OSSR. :param kwargs: Zenodo query arguments. For an exhaustive list, see the query arguments at https://developers.zenodo.org/#list36 Common arguments are: diff --git a/eossr/api/zenodo/__init__.py b/eossr/api/zenodo/__init__.py index cee4ed0468e7ea654000b13045c758ad525ffb61..043e31f02c67643af8cc08a2d1cf37c492434366 100644 --- a/eossr/api/zenodo/__init__.py +++ b/eossr/api/zenodo/__init__.py @@ -482,10 +482,11 @@ class Record: def get_zenodo_records(search='', sandbox=False, **kwargs): """ - Search the ossr based on `search`. + Search Zenodo for records whose names or descriptions include the provided string `search`. Function rewritten from pyzenodo3 (https://github.com/space-physics/pyzenodo3) :param search: string + A string to refine the search in Zenodo. The default will search for all records. :param kwargs: Zenodo query arguments. For an exhaustive list, see the query arguments at https://developers.zenodo.org/#list36 Common arguments are: