Skip to content

Fix basestring references in documentation #1106

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
jvegreg merged 2 commits into from
May 10, 2021
Merged

Fix basestring references in documentation #1106

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
8468013
Remove references to basestring
May 6, 2021
a10a5d2
Fix autoreplace errors
May 6, 2021
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
8 changes: 4 additions & 4 deletions esmvalcore/cmor/_fixes/fix.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ def __init__(self, vardef):

Parameters
----------
vardef: basestring
vardef: str
CMOR table entry

"""
Expand All @@ -31,14 +31,14 @@ def fix_file(self, filepath, output_dir):

Parameters
----------
filepath: basestring
filepath: str
file to fix
output_dir: basestring
output_dir: str
path to the folder to store the fixe files, if required

Returns
-------
basestring
str
Path to the corrected file. It can be different from the original
filepath if a fix has been applied, but if not it should be the
original filepath
Expand Down
18 changes: 9 additions & 9 deletions esmvalcore/cmor/check.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -981,13 +981,13 @@ def cmor_check_metadata(cube,
----------
cube: iris.cube.Cube
Data cube to check.
cmor_table: basestring
cmor_table: str
CMOR definitions to use.
mip:
Variable's mip.
short_name: basestring
short_name: str
Variable's short name.
frequency: basestring
frequency: str
Data frequency.
check_level: CheckLevels
Level of strictness of the checks.
Expand Down Expand Up @@ -1015,13 +1015,13 @@ def cmor_check_data(cube,
----------
cube: iris.cube.Cube
Data cube to check.
cmor_table: basestring
cmor_table: str
CMOR definitions to use.
mip:
Variable's mip.
short_name: basestring
short_name: str
Variable's short name
frequency: basestring
frequency: str
Data frequency
check_level: CheckLevels
Level of strictness of the checks.
Expand All @@ -1045,13 +1045,13 @@ def cmor_check(cube, cmor_table, mip, short_name, frequency, check_level):
----------
cube: iris.cube.Cube
Data cube to check.
cmor_table: basestring
cmor_table: str
CMOR definitions to use.
mip:
Variable's mip.
short_name: basestring
short_name: str
Variable's short name.
frequency: basestring
frequency: str
Data frequency.
check_level: enum.IntEnum
Level of strictness of the checks.
Expand Down
22 changes: 11 additions & 11 deletions esmvalcore/cmor/table.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ def get_table(self, table):

Parameters
----------
table: basestring
table: str
Table name

Returns
Expand All @@ -144,9 +144,9 @@ def get_variable(self, table_name, short_name, derived=False):

Parameters
----------
table_name: basestring
table_name: str
Table name
short_name: basestring
short_name: str
Variable's short name
derived: bool, optional
Variable is derived. Info retrieval for derived variables always
Expand Down Expand Up @@ -227,7 +227,7 @@ class CMIP6Info(InfoBase):

Parameters
----------
cmor_tables_path: basestring
cmor_tables_path: str
Path to the folder containing the Tables folder with the json files

default: object
Expand Down Expand Up @@ -367,7 +367,7 @@ def get_table(self, table):

Parameters
----------
table: basestring
table: str
Table name

Returns
Expand Down Expand Up @@ -616,7 +616,7 @@ class CMIP5Info(InfoBase):

Parameters
----------
cmor_tables_path: basestring
cmor_tables_path: str
Path to the folder containing the Tables folder with the json files

default: object
Expand Down Expand Up @@ -757,7 +757,7 @@ def get_table(self, table):

Parameters
----------
table: basestring
table: str
Table name

Returns
Expand All @@ -774,7 +774,7 @@ class CMIP3Info(CMIP5Info):

Parameters
----------
cmor_tables_path: basestring
cmor_tables_path: str
Path to the folder containing the Tables folder with the json files

default: object
Expand Down Expand Up @@ -811,7 +811,7 @@ class CustomInfo(CMIP5Info):

Parameters
----------
cmor_tables_path: basestring or None
cmor_tables_path: str or None
Full path to the table or name for the table if it is present in
ESMValTool repository
"""
Expand Down Expand Up @@ -848,9 +848,9 @@ def get_variable(self, table, short_name, derived=False):

Parameters
----------
table: basestring
table: str
Table name
short_name: basestring
short_name: str
Variable's short name
derived: bool, optional
Variable is derived. Info retrieval for derived variables always
Expand Down