Merge pull request #336 from MetOffice/335_cape_ratio_documentation_fix

Minor bug fix to cape ratio documentation
MetOffice · Dec 18, 2023 · ee0c889 · ee0c889
2 parents 2ebfa03 + 110b529
commit ee0c889
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/src/CSET/operators/convection.py b/src/CSET/operators/convection.py
@@ -102,17 +102,17 @@ def cape_ratio(SBCAPE, MUCAPE, MUCIN, MUCIN_thresh=-75.0):
 
     Examples
     --------
-    >>> CAPE_ratios_filter=elevated_convection_diagnostics.cape_ratio(
+    >>> CAPE_ratios=convection.cape_ratio(
             SBCAPE,MUCAPE,MUCIN)
     >>> iplt.pcolormesh(CAPE_ratios[0,:,:],cmap=mpl.cm.RdBu)
     >>> plt.gca().coastlines('10m')
     >>> plt.colorbar()
     >>> plt.clim(0,1)
     >>> plt.show()
 
-    >>> CAPE_ratios_filter=elevated_convection_diagnostics.cape_ratio(
+    >>> CAPE_ratios=convection.cape_ratio(
             SBCAPE,MUCAPE,MUCIN,MUCIN_thresh=-1.5)
-    >>> iplt.pcolormesh(CAPE_ratios_filter[0,:,:],cmap=mpl.cm.RdBu)
+    >>> iplt.pcolormesh(CAPE_ratios[0,:,:],cmap=mpl.cm.RdBu)
     >>> plt.gca().coastlines('10m')
     >>> plt.clim(0,1)
     >>> plt.colorbar()