Skip to content

fix typo in python api docs #168

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

Open
brycemines wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix typo in python api docs #168

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
8 changes: 4 additions & 4 deletions python/mantaray/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@ def single_ray(
Time step for the simulation
bathymetry : str
Path to a netCDF file containing the bathymetry file. It is expected
to have x and y dimensions as floats and depth (x, y) as a float,
to have x and y dimensions as floats and depth (y, x) as a float,
where depth is zero at surface and positive downwards.
current : str
Paths to a netCDF file containing the current field. It is expected
to have x and y dimensions as floats and u(x,y) and v(x,y) as floats.
to have x and y dimensions as floats and u(y,x) and v(y,x) as floats.

Return
------
Expand Down Expand Up @@ -96,11 +96,11 @@ def ray_tracing(
Time step for the simulation
bathymetry : str
Path to a netCDF file containing the bathymetry file. It is expected
x and y dimensions as floats and depth (x, y) as a float, where
x and y dimensions as floats and depth (y, x) as a float, where
depth is zero at surface and positive downwards.
current : str
Paths to a netCDF file containing the current field. It is expected
to have x and y dimensions as floats and u(x,y) and v(x,y) as floats.
to have x and y dimensions as floats and u(y,x) and v(y,x) as floats.

Returns
-------
Expand Down