From b9cd9f636dd58c9b265960372a92faab92c67b61 Mon Sep 17 00:00:00 2001 From: Bouwe Andela Date: Tue, 8 Nov 2022 15:23:42 +0100 Subject: [PATCH 1/2] Fix typo in docstring --- esmvalcore/esgf/_search.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/esmvalcore/esgf/_search.py b/esmvalcore/esgf/_search.py index 9dc831f992..b210d58dcc 100644 --- a/esmvalcore/esgf/_search.py +++ b/esmvalcore/esgf/_search.py @@ -181,11 +181,11 @@ def find_files(*, project, short_name, dataset, **facets): Examples -------- - Examples of how to use the search function for all supported projects. + Examples of how to use this function for all supported projects. Search for a CMIP3 dataset: - >>> search( + >>> find_files( ... project='CMIP3', ... frequency='mon', ... short_name='tas', @@ -197,7 +197,7 @@ def find_files(*, project, short_name, dataset, **facets): Search for a CMIP5 dataset: - >>> search( + >>> find_files( ... project='CMIP5', ... mip='Amon', ... short_name='tas', @@ -209,7 +209,7 @@ def find_files(*, project, short_name, dataset, **facets): Search for a CMIP6 dataset: - >>> search( + >>> find_files( ... project='CMIP6', ... mip='Amon', ... short_name='tas', @@ -222,7 +222,7 @@ def find_files(*, project, short_name, dataset, **facets): Search for a CORDEX dataset and limit the search results to files containing data to the years in the range 1990-2000: - >>> search( + >>> find_files( ... project='CORDEX', ... frequency='mon', ... dataset='COSMO-crCLIM-v1-1', @@ -239,7 +239,7 @@ def find_files(*, project, short_name, dataset, **facets): Search for a obs4MIPs dataset: - >>> search( + >>> find_files( ... project='obs4MIPs', ... frequency='mon', ... dataset='CERES-EBAF', From 109d1595b0d4d541c29d23a9fe127d2803ea565f Mon Sep 17 00:00:00 2001 From: Bouwe Andela Date: Tue, 8 Nov 2022 15:38:27 +0100 Subject: [PATCH 2/2] Fix another occurrence of the wrong function name --- esmvalcore/esgf/_download.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/esmvalcore/esgf/_download.py b/esmvalcore/esgf/_download.py index 7342040a52..a499879d6b 100644 --- a/esmvalcore/esgf/_download.py +++ b/esmvalcore/esgf/_download.py @@ -174,7 +174,7 @@ def sort_hosts(urls): class ESGFFile: """File on the ESGF. - This is the object returned by the function :func:`esmvalcore.esgf.search`. + This is the object returned by :func:`esmvalcore.esgf.find_files`. Attributes ----------