Add complete Docstring coverage

hdrake · Oct 15, 2024 · 83eec2d · 83eec2d
1 parent f1ef345
commit 83eec2d
Show file tree

Hide file tree

Showing 3 changed files with 205 additions and 82 deletions.
diff --git a/examples/Baltic_example.ipynb b/examples/Baltic_example.ipynb
@@ -2,27 +2,18 @@
  "cells": [
   {
    "cell_type": "code",
-   "execution_count": 42,
+   "execution_count": 1,
    "id": "182a8d3a-09f8-448e-a029-d03db69bbe44",
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "The autoreload extension is already loaded. To reload it, use:\n",
-      "  %reload_ext autoreload\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "%load_ext autoreload\n",
     "%autoreload 2"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 43,
+   "execution_count": 2,
    "id": "99c3a046-9435-46a6-b9c2-81becd029d93",
    "metadata": {},
    "outputs": [],
@@ -33,7 +24,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 44,
+   "execution_count": 3,
    "id": "0b71a055-e428-4a25-9edb-45ea25ce9b95",
    "metadata": {},
    "outputs": [],
@@ -49,7 +40,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 45,
+   "execution_count": 4,
    "id": "14961e68-c322-44d2-97de-51ba37ee012b",
    "metadata": {},
    "outputs": [
@@ -58,9 +49,9 @@
      "output_type": "stream",
      "text": [
       "xgcm version 0.8.2.dev15+g7492277 \n",
-      "regionate version 0.0.1 \n",
-      "xwmt version 0.1.1 \n",
-      "xwmb version 0.1.1\n"
+      "regionate version 0.1.1 \n",
+      "xwmt version 0.2.1 \n",
+      "xwmb version 0.2.1\n"
      ]
     }
    ],
@@ -78,7 +69,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 46,
+   "execution_count": 5,
    "id": "5d10e8dd-e134-4a50-9222-ae8f64184a7a",
    "metadata": {},
    "outputs": [],
@@ -129,7 +120,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 47,
+   "execution_count": 6,
    "id": "7fe739ce-eb59-481a-b4ed-cecd56532dd9",
    "metadata": {},
    "outputs": [],
@@ -150,7 +141,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 48,
+   "execution_count": 7,
    "id": "d0a9ffd6-007e-41df-a156-74f5c853cb6b",
    "metadata": {},
    "outputs": [
@@ -172,7 +163,7 @@
        "  * outer    sigma2_i_target --> center"
       ]
      },
-     "execution_count": 48,
+     "execution_count": 7,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -210,7 +201,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 49,
+   "execution_count": 8,
    "id": "83dde094-1b87-4e5d-9ab9-fac06938c6af",
    "metadata": {},
    "outputs": [
@@ -241,15 +232,15 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 50,
+   "execution_count": 9,
    "id": "626fc654-b1e5-4b0e-974e-0321f529ea9d",
    "metadata": {},
    "outputs": [
     {
      "name": "stderr",
      "output_type": "stream",
      "text": [
-      "/vftmp/Henri.Drake/pid24840/ipykernel_19376/2523156101.py:14: MatplotlibDeprecationWarning: Getting the array from a PolyQuadMesh will return the full array in the future (uncompressed). To get this behavior now set the PolyQuadMesh with a 2D array .set_array(data2d).\n",
+      "/vftmp/Henri.Drake/pid30318/ipykernel_18855/2523156101.py:14: MatplotlibDeprecationWarning: Getting the array from a PolyQuadMesh will return the full array in the future (uncompressed). To get this behavior now set the PolyQuadMesh with a 2D array .set_array(data2d).\n",
       "  plt.colorbar(pc, label=\"depth [m]\")\n"
      ]
     },
@@ -294,7 +285,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 51,
+   "execution_count": 10,
    "id": "da5b3b64-5984-4679-ae40-d857c0331082",
    "metadata": {},
    "outputs": [],
@@ -316,7 +307,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 52,
+   "execution_count": 11,
    "id": "9c0aba23-efc7-42d6-bbbb-0d0ff905cc81",
    "metadata": {},
    "outputs": [
@@ -341,7 +332,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 53,
+   "execution_count": 12,
    "id": "710df318-71ee-4cf5-9e5e-3131057b514e",
    "metadata": {},
    "outputs": [
@@ -385,7 +376,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 54,
+   "execution_count": 13,
    "id": "a8662a9e-1865-4bcf-90a9-82d231e74ba8",
    "metadata": {},
    "outputs": [],
@@ -404,7 +395,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 55,
+   "execution_count": 14,
    "id": "0d6e91a4-f915-4e58-9dfe-83acf7d913f2",
    "metadata": {},
    "outputs": [
@@ -458,7 +449,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 56,
+   "execution_count": 15,
    "id": "83fb1681-d2ce-45af-826b-d6e589b9d4c1",
    "metadata": {},
    "outputs": [],
@@ -480,7 +471,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 57,
+   "execution_count": 16,
    "id": "7292e9bb-3afd-4b90-ab49-c30c718d4d7c",
    "metadata": {},
    "outputs": [],
@@ -505,7 +496,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 58,
+   "execution_count": 17,
    "id": "c1888481-9941-4c3f-b515-dfba20fd59c2",
    "metadata": {},
    "outputs": [
@@ -530,7 +521,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 59,
+   "execution_count": 18,
    "id": "fa6b4d3d-c62c-4728-afd7-e3ab59e94a5b",
    "metadata": {},
    "outputs": [
@@ -571,6 +562,14 @@
    "outputs": [],
    "source": []
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "0c7187b3-6458-4d0b-9be9-436918ae460c",
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  },
   {
    "cell_type": "code",
    "execution_count": null,