Skip to content

Commit

Permalink
style: spelling mistakes
Browse files Browse the repository at this point in the history
  • Loading branch information
mdtanker committed Jan 29, 2024
1 parent fa67b53 commit 4c29294
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 15 deletions.
9 changes: 4 additions & 5 deletions src/polartoolkit/fetch.py
Original file line number Diff line number Diff line change
Expand Up @@ -291,9 +291,8 @@ def mass_change(
) -> typing.Any:
"""
Ice-sheet height and thickness changes from ICESat to ICESat-2.
from Smith et al. “Pervasive Ice Sheet Mass Loss Reflects Competing Ocean and
Atmosphere Processes.” Science, April 30, 2020, eaaz5845.
https://doi.org/10.1126/science.aaz5845.
from Smith et al. ,Pervasive ice sheet mass loss reflects competing ocean and
atmosphere processes.Science368,1239-1242(2020).DOI:10.1126/science.aaz5845
Choose a version of the data to download with the format: "ais_VERSION_TYPE" where
VERSION is "dhdt" for total thickness change or "dmdt" for corrected for firn-air
Expand Down Expand Up @@ -2991,7 +2990,7 @@ def preprocessing(fname: str, action: str, _pooch2: typing.Any) -> str:
registration = initial_registration

def preprocessing(fname: str, action: str, _pooch2: typing.Any) -> str:
"convert geosoft grd to xarrya dataarray and save it back as a .nc"
"convert geosoft grd to xarray dataarray and save it back as a .nc"
fname1 = Path(fname)

# Rename to the file to ***_preprocessed.nc
Expand Down Expand Up @@ -3058,7 +3057,7 @@ def ghf(
Load 1 of 6 'versions' of Antarctic geothermal heat flux data.
version='an-2015'
From At et al. 2015: emperature, lithosphere-asthenosphere boundary, and heat flux
From At et al. 2015: Temperature, lithosphere-asthenosphere boundary, and heat flux
beneath the Antarctic Plate inferred from seismic velocities
http://dx.doi.org/doi:10.1002/2015JB011917
Accessed from http://www.seismolab.org/model/antarctica/lithosphere/index.html
Expand Down
4 changes: 2 additions & 2 deletions src/polartoolkit/maps.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ def basemap(
**kwargs: typing.Any,
) -> pygmt.Figure:
"""
create a blank basemap figure, or add a basemape to an existing figure / subplot.
create a blank basemap figure, or add a basemap to an existing figure / subplot.
Parameters
----------
Expand All @@ -72,7 +72,7 @@ def basemap(
fig_width : float | None, optional
width of figure, by default None
origin_shift : str, optional
choose to start new figure, or shift origin of existing figure to add a subplt,
choose to start new figure, or shift origin of existing figure to add a subplot,
by default "initialize"
Returns
Expand Down
10 changes: 5 additions & 5 deletions src/polartoolkit/profile.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ def create_profile(
start : tuple[float, float], optional
Coordinates for starting point of profile, by default None
stop : tuple[float, float], optional
Coordinates for eding point of profile, by default None
Coordinates for ending point of profile, by default None
num : int, optional
Number of points to sample at, for "points" by default is 100, for other methods
num by default is determined by shapefile or dataframe
Expand Down Expand Up @@ -155,7 +155,7 @@ def sample_grids(
----------
df : pd.DataFrame
Dataframe containing columns 'x', 'y', or columns with names defined by kwarg
"coor_names".
"coord_names".
grid : str or xr.DataArray
Grid to sample, either file name or xr.DataArray
sampled_name : str,
Expand Down Expand Up @@ -976,7 +976,7 @@ def plot_profile(
raise ValueError(msg)

# plot imagery, or supplied grid as background
# can't use maps.plot_grd becauseit reset projection
# can't use maps.plot_grd because it reset projection
if kwargs.get("map_grd2cpt", False) is True:
pygmt.grd2cpt(
cmap=kwargs.get("map_cmap", "earth"),
Expand Down Expand Up @@ -1366,7 +1366,7 @@ def plot_data(
raise ValueError(msg)

# plot imagery, or supplied grid as background
# can't use maps.plot_grd becauseit reset projection
# can't use maps.plot_grd because it reset projection
if kwargs.get("map_grd2cpt", False) is True:
pygmt.grd2cpt(
cmap=kwargs.get("map_cmap", "earth"),
Expand Down Expand Up @@ -1547,7 +1547,7 @@ def cum_dist(df: pd.DataFrame, **kwargs: typing.Any) -> pd.DataFrame:
def draw_lines(**kwargs: typing.Any) -> typing.Any:
"""
Plot an interactive map, and use the "Draw a Polyline" button to create vertices of
a line. Verticles will be returned as the output of the function.
a line. Vertices will be returned as the output of the function.
Returns
-------
Expand Down
2 changes: 1 addition & 1 deletion src/polartoolkit/regions.py
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ def combine_regions(
def draw_region(**kwargs: typing.Any) -> typing.Any:
"""
Plot an interactive map, and use the "Draw a Rectangle" button to draw a rectangle
and get the bounding region. Verticles will be returned as the output of the
and get the bounding region. Vertices will be returned as the output of the
function.
Returns
Expand Down
4 changes: 2 additions & 2 deletions src/polartoolkit/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ def region_xy_to_ll(
region : tuple[typing.Any, typing.Any, typing.Any, typing.Any]
region boundaries in GMT format; [e, w, n, s] in meters
dms: bool, False
if True, will return results as deg:min:sec iinstead of decimal degrees
if True, will return results as deg:min:sec instead of decimal degrees
Returns
-------
Expand Down Expand Up @@ -610,7 +610,7 @@ def alter_region(
n_shift : float, optional
shift north, or south if negative, in meters, by default 0
w_shift : float, optional
shift west, or eash if negative, in meters, by default 0
shift west, or east if negative, in meters, by default 0
buffer : float, optional
create new region which is zoomed out in all direction, in meters, by default 0
print_reg : bool, optional
Expand Down

0 comments on commit 4c29294

Please sign in to comment.