Skip to content
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

Improve docstring #1150

Merged
merged 1 commit into from
Sep 26, 2024
Merged

Improve docstring #1150

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 additions & 2 deletions pcmdi_metrics/io/xcdat_openxml.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,11 @@ def xcdat_open(
# Open a single netCDF file
>>> ds = xcdat_open('mydata.nc')
# Open multiple files
>>> ds2 = xcdat_open(['mydata1.nc', 'mydata2.nc'] # Open multipe netCDF files
>>> ds = xcdat_open(['mydata1.nc', 'mydata2.nc']) # Open multipe netCDF files
# Open multiple files using a wildcard
>>> ds = xcdat_open('mydata*.nc')
# Open with specifing the variable 'ts'
>>> ds3 = xcdat_open(['mydata1.nc', 'mydata2.nc'], data_var='ts')
>>> ds = xcdat_open(['mydata1.nc', 'mydata2.nc'], data_var='ts')
# Open an xml file
>>> ds = xcdat_open('mydata.xml')
"""
Expand Down
Loading