Skip to content

Fix mistake in the documentation of esmvalcore.esgf.find_files #1784

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
valeriupredoi merged 2 commits into from
Nov 10, 2022
Merged

Fix mistake in the documentation of esmvalcore.esgf.find_files #1784

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b9cd9f6
Fix typo in docstring
bouweandela Nov 8, 2022
109d159
Fix another occurrence of the wrong function name
bouweandela Nov 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion esmvalcore/esgf/_download.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
----------
Expand Down
12 changes: 6 additions & 6 deletions esmvalcore/esgf/_search.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand All @@ -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',
Expand All @@ -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',
Expand All @@ -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',
Expand All @@ -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',
Expand Down