refactor: change module name from profile to profiles to match pl…

…ural style of other modules. BREAKING CHANGE: please update all import statements to use `profiles` instead of `profile`!
mdtanker · Jun 14, 2024 · 84524e3 · 84524e3
1 parent f374dd2
commit 84524e3
Show file tree

Hide file tree

Showing 13 changed files with 1,764 additions and 1,756 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -13,7 +13,7 @@ exclude: |
       docs/api/polartoolkit.rst|
       docs/api/polartoolkit.fetch.rst|
       docs/api/polartoolkit.maps.rst|
-      docs/api/polartoolkit.profile.rst|
+      docs/api/polartoolkit.profiles.rst|
       docs/api/polartoolkit.regions.rst|
       docs/api/polartoolkit.utils.rst|
       docs/_polartoolkit_refs.bib|

diff --git a/docs/api/polartoolkit.profile.rst b/docs/api/polartoolkit.profile.rst
diff --git a/docs/api/polartoolkit.profiles.rst b/docs/api/polartoolkit.profiles.rst
@@ -0,0 +1,6 @@
+polartoolkit.profiles
+--------------------
+.. automodule:: polartoolkit.profiles
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/polartoolkit.rst b/docs/api/polartoolkit.rst
@@ -7,6 +7,6 @@ API Reference
 
    polartoolkit.fetch
    polartoolkit.maps
-   polartoolkit.profile
+   polartoolkit.profiles
    polartoolkit.regions
    polartoolkit.utils
diff --git a/docs/gallery/index.md b/docs/gallery/index.md
@@ -16,7 +16,7 @@ subplot_layout
 
 ## Profiles
 
-Here are some examples for use the module `Profile`.
+Here are some examples for use the module `Profiles`.
 
 ```{nbgallery}
 ---

diff --git a/docs/how_to/profiles.ipynb b/docs/how_to/profiles.ipynb
diff --git a/docs/overview.md b/docs/overview.md
@@ -25,7 +25,7 @@ Create high-quality maps using PyGMT with functions specifically tailored to
 Antarctica (and soon to include Greenland and the Arctic). plot types: 2D, 3D,
 subplots, interactive maps
 
-### Profile
+### Profiles
 
 Define a line, sample layers & data along it, and plot the results.
 

diff --git a/docs/quickstart.ipynb b/docs/quickstart.ipynb
@@ -18,7 +18,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": 7,
    "metadata": {
     "execution": {
      "iopub.execute_input": "2024-02-09T04:53:05.977192Z",
@@ -29,7 +29,7 @@
    },
    "outputs": [],
    "source": [
-    "from polartoolkit import fetch, maps, profile, regions"
+    "from polartoolkit import fetch, maps, profiles, regions"
    ]
   },
   {
@@ -129,7 +129,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Define a profile between two points and plot a cross section of ice, ocean, and earth layers between them using the `profile` module. "
+    "Define a profile between two points and plot a cross section of ice, ocean, and earth layers between them using the `profiles` module. "
    ]
   },
   {
@@ -164,7 +164,7 @@
     "a = (1925000, 830000)\n",
     "b = (2200000, 600000)\n",
     "\n",
-    "fig, _, _ = profile.plot_profile(\n",
+    "fig, _, _ = profiles.plot_profile(\n",
     "    method=\"points\",\n",
     "    start=a,\n",
     "    stop=b,\n",
@@ -190,7 +190,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.1.-1"
+   "version": "3.11.9"
   },
   "vscode": {
    "interpreter": {

diff --git a/docs/tutorial/cross_sections_and_profiles.ipynb b/docs/tutorial/cross_sections_and_profiles.ipynb
@@ -23,7 +23,7 @@
    "source": [
     "import os\n",
     "\n",
-    "from polartoolkit import profile"
+    "from polartoolkit import profiles"
    ]
   },
   {
@@ -72,7 +72,7 @@
     "a = (1925000, 830000)\n",
     "b = (2200000, 600000)\n",
     "\n",
-    "fig, _, _ = profile.plot_profile(\n",
+    "fig, _, _ = profiles.plot_profile(\n",
     "    method=\"points\",\n",
     "    start=a,\n",
     "    stop=b,\n",
@@ -115,7 +115,7 @@
     }
    ],
    "source": [
-    "fig, _, _ = profile.plot_profile(\n",
+    "fig, _, _ = profiles.plot_profile(\n",
     "    method=\"points\",\n",
     "    start=a,\n",
     "    stop=b,\n",
@@ -152,7 +152,7 @@
     }
    ],
    "source": [
-    "fig, _ = profile.plot_data(\n",
+    "fig, _ = profiles.plot_data(\n",
     "    method=\"points\",\n",
     "    start=a,\n",
     "    stop=b,\n",
@@ -196,7 +196,7 @@
     }
    ],
    "source": [
-    "fig, _, _ = profile.plot_profile(\n",
+    "fig, _, _ = profiles.plot_profile(\n",
     "    method=\"points\",\n",
     "    start=a,\n",
     "    stop=b,\n",