fix(DeprecationWarning): resolve invalid escape sequences \_, \m, \c

.flake8

@@ -31,7 +31,6 @@ ignore =
     W293, # blank line contains whitespace
     W391, # blank line at end of file
     W503, # line break before binary operator
-    W504, # line break after binary operator
-    W605  # invalid escape sequence
+    W504  # line break after binary operator
 
 statistics = True

flopy/mf6/modflow/mfgwfmaw.py

@@ -301,14 +301,14 @@ class ModflowGwfmaw(mfpackage.MFPackage):
                   well, which is the minimum of the well RATE or the well
                   inflow rate from the aquifer. HEAD_LIMIT can be applied to
                   extraction wells (RATE :math:`<` 0) or injection wells (RATE
-                  :math:`>` 0). HEAD\_LIMIT can be deactivated by specifying
-                  the text string `OFF'. The HEAD\_LIMIT option is based on the
-                  HEAD\_LIMIT functionality available in the
-                  MNW2~\citep{konikow2009} package for MODFLOW-2005. The
-                  HEAD\_LIMIT option has been included to facilitate backward
+                  :math:`>` 0). HEAD_LIMIT can be deactivated by specifying
+                  the text string `OFF'. The HEAD_LIMIT option is based on the
+                  HEAD_LIMIT functionality available in the
+                  MNW2 package for MODFLOW-2005. The
+                  HEAD_LIMIT option has been included to facilitate backward
                   compatibility with previous versions of MODFLOW but use of
-                  the RATE\_SCALING option instead of the HEAD\_LIMIT option is
-                  recommended. By default, HEAD\_LIMIT is `OFF'.
+                  the RATE_SCALING option instead of the HEAD_LIMIT option is
+                  recommended. By default, HEAD_LIMIT is `OFF'.
             shutoffrecord : [minrate, maxrate]
                 * minrate (double) is the minimum rate that a well must exceed
                   to shutoff a well during a stress period. The well will shut

flopy/mf6/modflow/mfgwfuzf.py

@@ -217,7 +217,7 @@ class ModflowGwfuzf(mfpackage.MFPackage):
           a given volume of soil divided by that volume. Values range from 0 to
           about 3 :math:`cm^{-2}`, depending on the plant community and its
           stage of development. ROOTACT is always specified, but is only used
-          if SIMULATE\_ET and UNSAT\_ETAE are specified in the OPTIONS block.
+          if SIMULATE_ET and UNSAT_ETAE are specified in the OPTIONS block.
           If the Options block includes a TIMESERIESFILE entry (see the "Time-
           Variable Input" section), values can be obtained from a time series
           by entering the time-series name in place of a numeric value.

flopy/mf6/modflow/mfims.py

@@ -201,8 +201,8 @@ class ModflowIms(mfpackage.MFPackage):
           residual increases, while a low value serves to control step size
           more severely. The value usually ranges from 1.0 to 10:math:`^6`; a
           value of 10:math:`^4` works well for most problems but lower values
-          like 1.1 may be required for harder problems. BACKTRACKING\_TOLERANCE
-          only needs to be specified if BACKTRACKING\_NUMBER is greater than
+          like 1.1 may be required for harder problems. BACKTRACKING_TOLERANCE
+          only needs to be specified if BACKTRACKING_NUMBER is greater than
           zero.
     backtracking_reduction_factor : double
         * backtracking_reduction_factor (double) real value defining the
@@ -256,8 +256,8 @@ class ModflowIms(mfpackage.MFPackage):
           residual at any single node. Value is in units of length cubed per
           time, and must be consistent with mf length and time units. Usually a
           value of :math:`1.0 \\times 10^{-1}` is sufficient for the flow-
-          residual criteria when meters and seconds are the defined \mf length
-          and time.
+          residual criteria when meters and seconds are the defined
+          MODFLOW 6 length and time.
         * rclose_option (string) an optional keyword that defines the specific
           flow residual criterion used. STRICT--an optional keyword that is
           used to specify that INNER_RCLOSE represents a infinity-Norm
@@ -277,8 +277,8 @@ class ModflowIms(mfpackage.MFPackage):
           INNER_RCLOSE value is :math:`1.0 \\times 10^{-4}` and convergence is
           achieved for a given inner (linear) iteration when :math:`\\Delta h
           \\le` INNER_DVCLOSE and the current L-2 Norm is :math:`\\le` the
-          product of the RELATIVE\_RCLOSE and the initial L-2 Norm for the
-          current inner (linear) iteration. If RCLOSE\_OPTION is not specified,
+          product of the RELATIVE_RCLOSE and the initial L-2 Norm for the
+          current inner (linear) iteration. If RCLOSE_OPTION is not specified,
           an absolute residual (infinity-norm) criterion is used.
     linear_acceleration : string
         * linear_acceleration (string) a keyword that defines the linear
@@ -312,7 +312,7 @@ class ModflowIms(mfpackage.MFPackage):
           defines the drop tolerance used to drop preconditioner terms based on
           the magnitude of matrix entries in the ILUT and MILUT
           preconditioners. A value of :math:`10^{-4}` works well for most
-          problems. By default, PRECONDITIONER\_DROP\_TOLERANCE is zero and the
+          problems. By default, PRECONDITIONER_DROP_TOLERANCE is zero and the
           zero-fill incomplete LU factorization preconditioners (ILU(0) and
           MILU(0)) are used.
     number_orthogonalizations : integer