bugfix 729 main_v3.1 fix SyntaxError use case doc (#730)

* fixed formatted for use case doc * removed duplicate glossary items that were causing a warning when building the docs
dtcenter · Dec 11, 2020 · 114ec93 · 114ec93
1 parent e9a4406
commit 114ec93
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 18 deletions.
diff --git a/docs/Users_Guide/glossary.rst b/docs/Users_Guide/glossary.rst
@@ -1637,9 +1637,6 @@ METplus Configuration Glossary
    FCST_LEVEL
      .. warning:: **DEPRECATED:** Please use :term:`FCST_PCP_COMBINE_INPUT_ACCUMS` instead.
 
-   FCST_MAX_FORECAST
-     .. warning:: **DEPRECATED:** Please use :term:`LEAD_SEQ_MAX` instead.
-
    FCST_MODE_CONV_RADIUS
      Comma separated list of convolution radius values used by mode for forecast fields. A corresponding variable exists for observation data called :term:`OBS_MODE_CONV_RADIUS`.
 
@@ -4273,9 +4270,6 @@ METplus Configuration Glossary
    TIME_SUMMARY_VAR_NAMES
      .. warning:: **DEPRECATED:** Please use :term:`PB2NC_TIME_SUMMARY_VAR_NAMES` instead.
 
-   TIME_SUMMARY_TYPES
-     .. warning:: **DEPRECATED:** Please use :term:`PB2NC_TIME_SUMMARY_TYPES` instead.
-
    PB2NC_TIME_SUMMARY_TYPES
      Specify the time summary type list item in the MET pb2nc config file. Refer to the `MET User's Guide <https://dtcenter.org/community-code/model-evaluation-tools-met/documentation>`_ for more information.
 

diff --git a/...um_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_IVT.py b/...um_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_IVT.py
@@ -7,20 +7,19 @@
 _obsGFS_FeatureRelative
 _SeriesByLead_PyEmbed_IVT.conf
 
-"""
-
-========================================================================
-This use case calls multiple tools to produce diagnostic plots of systematic erros relative to a 
-feature (e.g. hurricane, MCS, etc...). This use case calls a user provided python script that 
-calculates a diagnostic of interest (e.g. integrated vapor transport, potential vorticity, etc...). 
-This user diagnostic is then used to define the systematic errors. This example calculates statistics
-over varying forecast leads with the ability to define lead groupings. This use case is very similar
-to the Multi_Tools: Feature Relative by Lead use case.
-(ADeck,GFS:BDeck,GFS:ATCF,Grib2)
 """
 ##############################################################################
 # Scientific Objective
 # --------------------
+#
+# This use case calls multiple tools to produce diagnostic plots of systematic erros relative to a
+# feature (e.g. hurricane, MCS, etc...). This use case calls a user provided python script that
+# calculates a diagnostic of interest (e.g. integrated vapor transport, potential vorticity, etc...).
+# This user diagnostic is then used to define the systematic errors. This example calculates statistics
+# over varying forecast leads with the ability to define lead groupings. This use case is very similar
+# to the Multi_Tools: Feature Relative by Lead use case.
+# (ADeck,GFS:BDeck,GFS:ATCF,Grib2)
+#
 # By maintaining focus of each evaluation time (or evaluation time series, in this case)
 # on a user-defined area around a cyclone, the model statistical errors associated
 # with cyclonic physical features (moisture flux, stability, strength of upper-level
@@ -93,7 +92,8 @@
 # 
 # PyEmbedIngest, TCPairs, ExtractTiles, SeriesByLead
 #
-# This example loops by forecast/lead time (with begin, end, and increment as specified in the METplus TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_IVT.conf file). 
+# This example loops by forecast/lead time (with begin, end, and increment as specified in the METplus
+# TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_IVT.conf file).
 #
 # 4 initialization times will be run over 5 lead times:
 #
@@ -150,7 +150,7 @@
 #
 # This use case can be run two ways:
 #
-# 1) Passing in TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_IVT.conf
+# 1) Passing in TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_IVT.conf,
 # then a user-specific system configuration file::
 #
 #        master_metplus.py \