fixup docs

docs/developers_guide/ocean/tasks/barotropic_gyre.md

@@ -7,7 +7,7 @@ The barotropic_gyre task group is currently comprised of one `default` task.
 ## framework
 
 The shared config options for `barotropic_gyre` tests  are described in
-{ref}`ocean-barotropic-` in the User's Guide.
+{ref}`ocean-barotropic-gyre` in the User's Guide.
 
 Additionally, the tests share a `forward.yaml` file with a few common model
 config options related to time management, time integration, and Laplacian

docs/users_guide/ocean/tasks/barotropic_gyre.md

@@ -1,10 +1,10 @@
 (ocean-barotropic-gyre)=
 
-# barotropic_gyre
+# barotropic gyre
 
 The barotropic gyre test case implements the Munk model for a simplified,
 wind-driven gyre
-[Munk 1950](https://doi.org/10.1175/1520-0469%281950%29007%3C0080:OTWDOC%3E2.0.CO;2).
+([Munk 1950](https://doi.org/10.1175/1520-0469%281950%29007%3C0080:OTWDOC%3E2.0.CO;2)).
 It is a variant of the Stommel model except it uses Laplacian horizontal
 viscosity rather than drag to balance the wind stress. As such, this test case
 may be used to verify the Laplacian viscosity term and the wind stress forcing
@@ -25,7 +25,7 @@ produced:
 
 ```{image} images/barotropic_gyre_solution.png
 :align: center
-:width: 500 px
+:width: 800 px
 ```
 
 ## mesh
@@ -87,6 +87,11 @@ $$
 
 where `tau_0` is given by a config option.
 
+```{image} images/barotropic_gyre_forcing.png
+:align: center
+:width: 500 px
+```
+
 ### config options
 
 ```cfg

polaris/ocean/tasks/barotropic_gyre/forward.py

@@ -155,6 +155,19 @@ def dynamic_model_config(self, at_setup):
 
 
 def compute_max_time_step(config):
+    """
+    Compute the approximate maximum time step for stability
+
+    Parameters
+    ----------
+    config : polaris.config.PolarisConfigParser
+        Config options for test case
+
+    Returns
+    -------
+    dt_max : float
+        The approximate maximum time step for stability
+    """
     u_max = 1.  # m/s
     stability_parameter_max = 0.25
     resolution = config.getfloat('barotropic_gyre', 'resolution')