Skip to content

Commit

Permalink
chore: formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
mdtanker committed Jan 26, 2024
1 parent 70f7d18 commit 52fd5bb
Show file tree
Hide file tree
Showing 17 changed files with 19 additions and 15 deletions.
8 changes: 3 additions & 5 deletions README.md
Expand Up @@ -64,9 +64,8 @@ update PolarToolkit to a newer version.

I welcome any feedback, ideas, or contributions! Please contact us on the
[GitHub discussions page](https://github.com/mdtanker/polartoolkit/discussions)
or submit an
[issue on GitHub](https://github.com/mdtanker/polartoolkit/issues) for
problems or feature ideas.
or submit an [issue on GitHub](https://github.com/mdtanker/polartoolkit/issues)
for problems or feature ideas.

<!-- SPHINX-START2 -->

Expand Down Expand Up @@ -98,8 +97,7 @@ I really welcome all forms of contribution! If you have any questions, comments
or suggestions, please open a [discussion]() or [issue (feature request)]() on
the [GitHub page](https://github.com/mdtanker/polartoolkit/)!

Also, please feel free to share how you're using PolarToolkit, I'd love to
know.
Also, please feel free to share how you're using PolarToolkit, I'd love to know.

Please, read our
[Contributor Guide](https://github.com/mdtanker/polartoolkit/blob/main/.github/CONTRIBUTING.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/api/antarctic_plots.fetch.rst
Expand Up @@ -3,4 +3,4 @@ antarctic\_plots.fetch
.. automodule:: polartoolkit.fetch
:members:
:undoc-members:
:show-inheritance:
:show-inheritance:
2 changes: 1 addition & 1 deletion docs/api/antarctic_plots.maps.rst
Expand Up @@ -3,4 +3,4 @@ antarctic\_plots.maps
.. automodule:: polartoolkit.maps
:members:
:undoc-members:
:show-inheritance:
:show-inheritance:
2 changes: 1 addition & 1 deletion docs/api/antarctic_plots.profile.rst
Expand Up @@ -3,4 +3,4 @@ antarctic\_plots.profile
.. automodule:: polartoolkit.profile
:members:
:undoc-members:
:show-inheritance:
:show-inheritance:
2 changes: 1 addition & 1 deletion docs/api/antarctic_plots.regions.rst
Expand Up @@ -3,4 +3,4 @@ antarctic\_plots.regions
.. automodule:: polartoolkit.regions
:members:
:undoc-members:
:show-inheritance:
:show-inheritance:
2 changes: 1 addition & 1 deletion docs/api/antarctic_plots.utils.rst
Expand Up @@ -3,4 +3,4 @@ antarctic\_plots.utils
.. automodule:: polartoolkit.utils
:members:
:undoc-members:
:show-inheritance:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/gallery/3D_stack.ipynb
Expand Up @@ -26,7 +26,6 @@
"\n",
"# set Python's logging level to get information\n",
"import logging\n",
"import pooch\n",
"\n",
"from polartoolkit import fetch, maps, regions\n",
"\n",
Expand Down
1 change: 1 addition & 0 deletions docs/gallery/mask_from_shp.ipynb
Expand Up @@ -25,6 +25,7 @@
"%autoreload 2\n",
"\n",
"import pyogrio\n",
"\n",
"from polartoolkit import fetch, maps, regions, utils"
]
},
Expand Down
1 change: 1 addition & 0 deletions docs/gallery/setting_projection.ipynb
Expand Up @@ -36,6 +36,7 @@
"import logging\n",
"\n",
"import pygmt\n",
"\n",
"from polartoolkit import fetch, maps, utils\n",
"\n",
"logging.getLogger().setLevel(logging.INFO)"
Expand Down
1 change: 1 addition & 0 deletions docs/gallery/subplot_layout.ipynb
Expand Up @@ -17,6 +17,7 @@
"%load_ext autoreload\n",
"%autoreload 2\n",
"import pygmt\n",
"\n",
"from polartoolkit import fetch, maps, regions, utils"
]
},
Expand Down
4 changes: 2 additions & 2 deletions docs/install.md
Expand Up @@ -25,8 +25,8 @@ Activate the environment:

### Pip

Instead, you can use pip to install polartoolkit, but first you need to
install a few dependencies with conda. This is because `PyGMT` `GeoPandas`, and
Instead, you can use pip to install polartoolkit, but first you need to install
a few dependencies with conda. This is because `PyGMT` `GeoPandas`, and
`Cartopy` all rely on C packages, which can only be install with conda/mamba and
not with pip. ere I use mamba, but conda will work as well, just replace any
`mamba` with `conda`:
Expand Down
1 change: 1 addition & 0 deletions docs/tutorial/fetch_walkthrough.ipynb
Expand Up @@ -33,6 +33,7 @@
"import logging\n",
"\n",
"import pyogrio\n",
"\n",
"from polartoolkit import fetch, maps, regions, utils\n",
"\n",
"logging.getLogger().setLevel(logging.INFO)"
Expand Down
2 changes: 1 addition & 1 deletion src/polartoolkit/fetch.py
Expand Up @@ -29,14 +29,14 @@
import xarray as xr
import zarr
from dotenv import load_dotenv
from pyproj import Transformer

# import polartoolkit.fetch as fetch
from polartoolkit import ( # pylint: disable=import-self
fetch, # noqa: PLW0406
regions,
utils,
)
from pyproj import Transformer

# import polartoolkit.regions as regions
# import polartoolkit.utils as utils
Expand Down
1 change: 1 addition & 0 deletions src/polartoolkit/regions.py
Expand Up @@ -15,6 +15,7 @@

import pandas as pd
import verde as vd

from polartoolkit import ( # pylint: disable=import-self
maps,
regions, # noqa: PLW0406
Expand Down
2 changes: 1 addition & 1 deletion src/polartoolkit/utils.py
Expand Up @@ -21,10 +21,10 @@
import verde as vd
import xarray as xr
from nptyping import NDArray
from pyproj import Transformer

# import polartoolkit.fetch as fetch
from polartoolkit import fetch, maps
from pyproj import Transformer

# import polartoolkit.maps as maps

Expand Down
1 change: 1 addition & 0 deletions tests/test_fetch.py
Expand Up @@ -26,6 +26,7 @@ def test_():
import pytest
from dotenv import load_dotenv
from geopandas.testing import assert_geodataframe_equal

from polartoolkit import fetch, regions, utils

load_dotenv()
Expand Down
1 change: 1 addition & 0 deletions tests/test_utils.py
Expand Up @@ -16,6 +16,7 @@
import pytest
import verde as vd
import xarray as xr

from polartoolkit import regions, utils


Expand Down

0 comments on commit 52fd5bb

Please sign in to comment.