Fixing escaping characters in docstrings (#2952)

* Escaping underscore

* fixing other scaped chars

Author: germa89

src/ansys/mapdl/core/_commands/apdl/array_param.py

@@ -1141,7 +1141,8 @@ def voper(self, parr="", par1="", oper="", par2="", con1="", con2="", **kwargs):
               First derivative:
 
               .. math::
-                 \dfrac{\mathrm{d}(\mathrm{Par1})}{\mathrm{d}(\mathrm{Par2})}
+
+                 \\dfrac{\\mathrm{d}(\\mathrm{Par1})}{\\mathrm{d}(\\mathrm{Par2})}
 
               The derivative at a point is determined over points
               half way between the previous and next points
@@ -1154,7 +1155,8 @@ def voper(self, parr="", par1="", oper="", par2="", con1="", con2="", **kwargs):
               Second derivative:
 
               .. math::
-                 \dfrac{\mathrm{d}^2(\mathrm{Par1})}{\mathrm{d}(\mathrm{Par2})^2}
+
+                 \\dfrac{\\mathrm{d}^2(\\mathrm{Par1})}{\\mathrm{d}(\\mathrm{Par2})^2}
 
               See also ``DER1``.
 
@@ -1163,7 +1165,7 @@ def voper(self, parr="", par1="", oper="", par2="", con1="", con2="", **kwargs):
 
               .. math::
 
-                 \int Par1 \, d(Par2)
+                 \\int Par1 \\, d(Par2)
 
               where ``CON1`` is the integration constant.
               The integral at a point is
@@ -1175,7 +1177,7 @@ def voper(self, parr="", par1="", oper="", par2="", con1="", con2="", **kwargs):
 
               .. math::
 
-                 \iint Par1 \, d(Par2)
+                 \\iint Par1 \\, d(Par2)
 
               where ``CON1`` is the integration constant of the first
               integral and ``CON2`` is the integration constant

src/ansys/mapdl/core/_commands/apdl/macro_files.py

@@ -356,7 +356,7 @@ def rmdir(self, dir_="", **kwargs):
 
         Parameters
         ----------
-        dir\_
+        dir\\_
             The directory to remove. If no path is provided, it will be assumed
             to be in the current working directory. All files in the directory
             are also removed.

src/ansys/mapdl/core/_commands/apdl/matrix_op.py

@@ -102,7 +102,7 @@ def dmat(
         matrix
             Name used to identify the matrix. Must be specified.
 
-        type\_
+        type\\_
             Matrix type:
 
             Double precision real values (default). - Complex double precision values.
@@ -239,7 +239,7 @@ def export(
             Name of the matrix to export (must be a matrix previously created
             with ``*DMAT`` or ``*SMAT``, or a vector previously created with ``*VEC``).
 
-        format\_
+        format\\_
             Format of the output file:
 
             Export the matrix in the Matrix Market Format. - Export
@@ -302,7 +302,7 @@ def fft(
 
         Parameters
         ----------
-        type\_
+        type\\_
             Type of FFT transformation:
 
             Forward FFT computation (default). - Backward FFT computation.
@@ -420,7 +420,7 @@ def itengine(
 
         Parameters
         ----------
-        type\_
+        type\\_
             Specifies the algorithm to be used:
 
         enginename
@@ -834,7 +834,7 @@ def smat(
         matrix
             Name used to identify the matrix. Must be specified.
 
-        type\_
+        type\\_
             Matrix type:
 
             Double precision real values (default). - Complex double precision values.

src/ansys/mapdl/core/_commands/apdl/parameter_definition.py

@@ -65,7 +65,7 @@ def dim(
             Name of parameter to be dimensioned.  See ``*SET`` for name
             restrictions.
 
-        type\_
+        type\\_
             Array type:
 
             Arrays are similar to standard FORTRAN arrays (indices are
@@ -261,7 +261,7 @@ def get(
         Parameters
         ----------
         par : str, optional
-            The name of the resulting parameter. See \*SET for name
+            The name of the resulting parameter. See \\*SET for name
             restrictions.
 
         entity

src/ansys/mapdl/core/_commands/aux12_/radiosity_solver.py

@@ -360,7 +360,7 @@ def vfopt(
         ext
             Filename extension for view factor matrix. Default = .vf.
 
-        dir\_
+        dir\\_
             Directory path for view factor matrix. If you do not specify a
             directory path, it will default to your working directory.
 

src/ansys/mapdl/core/_commands/aux3_.py

@@ -88,13 +88,13 @@ def modify(
 
         Parameters
         ----------
-        set\_
+        set\\_
             Set of data in results file to be modified.
 
         lstep
             The new load step number.
 
-        iter\_
+        iter\\_
             The new load substep number.
 
         cumit

src/ansys/mapdl/core/_commands/database/components.py

@@ -394,7 +394,7 @@ def cmsel(
 
         Parameters
         ----------
-        type\_
+        type_
             Label identifying the type of select:
 
             S - Select a new set (default).

src/ansys/mapdl/core/_commands/database/picking.py

@@ -95,7 +95,7 @@ def flst(self, nfield="", narg="", type_="", otype="", leng="", **kwargs):
         narg
             Number of items in the picked list.
 
-        type\_
+        type\\_
             Type of items picked:
 
             1 - Node numbers

src/ansys/mapdl/core/_commands/database/selecting.py

@@ -99,7 +99,7 @@ def asll(self, type_="", arkey="", **kwargs):
 
         Parameters
         ----------
-        type\_
+        type\\_
             Label identifying the type of area select:
 
             S - Select a new set (default).
@@ -152,7 +152,7 @@ def asel(
 
         Parameters
         ----------
-        type\_
+        type\\_
             Label identifying the type of select:
 
             S - Select a new set (default)
@@ -272,7 +272,7 @@ def aslv(self, type_="", **kwargs):
 
         Parameters
         ----------
-        type\_
+        type\\_
             Label identifying the type of area select:
 
             S - Select a new set (default).
@@ -306,7 +306,7 @@ def dofsel(
 
         Parameters
         ----------
-        type\_
+        type\\_
             Label identifying the type of select:
 
             S - Select a new set of labels.
@@ -393,7 +393,7 @@ def esel(
 
         Parameters
         ----------
-        type\_
+        type\\_
             Label identifying the type of select:
 
             - S - Select a new set (default).
@@ -694,7 +694,7 @@ def ksel(
 
         Parameters
         ----------
-        type\_
+        type\\_
             Label identifying the type of select:
 
             S
@@ -808,7 +808,7 @@ def ksll(self, type_="", **kwargs):
 
         Parameters
         ----------
-        type\_
+        type\\_
             Label identifying the type of keypoint select:
 
             S - Select a new set (default).
@@ -833,7 +833,7 @@ def ksln(self, type_="", **kwargs):
 
         Parameters
         ----------
-        type\_
+        type\\_
             Label identifying the type of keypoint select:
 
             S - Select a new set (default).
@@ -883,7 +883,7 @@ def lsel(
 
         Parameters
         ----------
-        type\_
+        type\\_
             Label identifying the type of select:
 
             S - Select a new set (default).
@@ -995,7 +995,7 @@ def lsla(self, type_="", **kwargs):
 
         Parameters
         ----------
-        type\_
+        type\\_
             Label identifying the type of line select:
 
             S - Select a new set (default).
@@ -1020,7 +1020,7 @@ def lslk(self, type_="", lskey="", **kwargs):
 
         Parameters
         ----------
-        type\_
+        type\\_
             Label identifying the type of line select:
 
             S - Select a new set (default).
@@ -1074,7 +1074,7 @@ def nsel(
 
         Parameters
         ----------
-        type\_
+        type\\_
             Label identifying the type of select:
 
             S - Select a new set (default).
@@ -1235,7 +1235,7 @@ def nsla(self, type_="", nkey="", **kwargs):
 
         Parameters
         ----------
-        type\_
+        type\\_
             Label identifying the type of node select:
 
             S - Select a new set (default).
@@ -1282,7 +1282,7 @@ def nsle(self, type_="", nodetype="", num="", **kwargs):
 
         Parameters
         ----------
-        type\_
+        type\\_
             Label identifying the type of node select:
 
             S - Select a new set (default).
@@ -1345,7 +1345,7 @@ def nslk(self, type_="", **kwargs):
 
         Parameters
         ----------
-        type\_
+        type\\_
             Label identifying the type of node select:
 
             S - Select a new set (default).
@@ -1374,7 +1374,7 @@ def nsll(self, type_="", nkey="", **kwargs):
 
         Parameters
         ----------
-        type\_
+        type\\_
             Label identifying the type of node select:
 
             S - Select a new set (default).
@@ -1411,7 +1411,7 @@ def nslv(self, type_="", nkey="", **kwargs):
 
         Parameters
         ----------
-        type\_
+        type\\_
             Label identifying the type of node select:
 
             S - Select a new set (default).
@@ -1447,7 +1447,7 @@ def partsel(self, type_="", pmin="", pmax="", pinc="", **kwargs):
 
         Parameters
         ----------
-        type\_
+        type\\_
             Label identifying type of select. Because PARTSEL is a command
             macro, the label must be enclosed in single quotes.
 
@@ -1536,7 +1536,7 @@ def vsel(
 
         Parameters
         ----------
-        type\_
+        type\\_
             Label identifying the type of volume select:
 
             S - Select a new set (default).
@@ -1633,7 +1633,7 @@ def vsla(self, type_="", vlkey="", **kwargs):
 
         Parameters
         ----------
-        type\_
+        type\\_
             Label identifying the type of volume select:
 
             S - Select a new set (default).

src/ansys/mapdl/core/_commands/graphics_/annotation.py

@@ -159,7 +159,7 @@ def anum(self, num="", type_="", xhot="", yhot="", **kwargs):
             number is available; ANSYS will substitute the lowest available
             number in place of any user-specified higher number.
 
-        type\_
+        type\\_
             Annotation internal type number.  If TYPE = DELE, delete annotation
             NUM.