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.

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

Update create_grid args to improve usability #507

Merged
merged 15 commits into from
Jul 7, 2023
Merged
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
Adds additional suggested fixes
jasonb5 committed Jun 27, 2023

Unverified

This user has not yet uploaded their public signing key.
commit 171f9b919f0f072fb13329b4b631dc1d6b333115
4 changes: 2 additions & 2 deletions xcdat/regridder/grid.py
Original file line number Diff line number Diff line change
@@ -632,7 +632,7 @@ def create_axis(
"height"). xCDAT also accepts additional names such as "lon", "lat",
and "lev". Refer to ``xcdat.axis.VAR_NAME_MAP`` for accepted names.
data : Union[List[Union[int, float]], np.ndarray]
1-D axis data.
1-D axis data consisting of integers or floats.
bounds : Optional[Union[List[List[Union[int, float]]], np.ndarray]]
2-D axis bounds data consisting of integers or floats, defaults to None.
Must have a shape of n x 2, where n is the length of ``data``.
@@ -663,7 +663,7 @@ def create_axis(
>>> lat, bnds = create_axis("lat", np.array([-45, 0, 45]))
Create axis and bounds from List:
Create axis and bounds from list of floats:
>>> lat, bnds = create_axis("lat", [-45, 0, 45], bounds=[[-67.5, -22.5], [-22.5, 22.5], [22.5, 67.5]])