Merge branch 'docstring' into 'master'

improve docstring of get_ossr_records taht was not clear enough

See merge request !46

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:

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: