Skip to content
Snippets Groups Projects
Commit 426c2e16 authored by vuillaut's avatar vuillaut
Browse files

improve docstring of get_ossr_records taht was not clear enough

parent 2cb9b5f0
No related branches found
No related tags found
1 merge request!46improve docstring of get_ossr_records taht was not clear enough
Pipeline #137728 passed
......@@ -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:
......
......@@ -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:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment