Some format fix in docstrings (#2954)

* Some format fix

* Apply suggestions from code review

Author: germa89

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

@@ -77,8 +77,12 @@ def abbres(self, lab="", fname="", ext="", **kwargs):
         lab
             Label that specifies the read operation:
 
-            Replace current abbreviation set with these abbreviations (default). - Extend current abbreviation set with these abbreviations, replacing any of the
-                              same name that already exist.
+            NEW
+                Replace current abbreviation set with these abbreviations (default).
+
+            CHANGE
+                Extend current abbreviation set with these abbreviations, replacing any of the
+                same name that already exist.
 
         fname
             File name and directory path (248 characters maximum, including the

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

@@ -32,9 +32,13 @@ def mfouri(self, oper="", coeff="", mode="", isym="", theta="", curve="", **kwar
         oper
             Type of Fourier operation:
 
-            Calculate Fourier coefficients COEFF from MODE, ISYM,
-            THETA, and CURVE. - Evaluate the Fourier curve CURVE from
-            COEFF, MODE, ISYM and THETA.
+            FIT
+              Calculate Fourier coefficients COEFF from MODE, ISYM,
+              THETA, and CURVE.
+
+            EVAL
+              Evaluate the Fourier curve CURVE from
+              COEFF, MODE, ISYM and THETA.
 
         coeff
             Name of the array parameter vector containing the Fourier
@@ -50,7 +54,11 @@ def mfouri(self, oper="", coeff="", mode="", isym="", theta="", curve="", **kwar
             the corresponding Fourier terms.  The vector should contain keys
             for each term as follows:
 
-            Symmetric (cosine) term - Antisymmetric (sine) term.
+            0 or 1
+              Symmetric (cosine) term
+
+            -1
+              Antisymmetric (sine) term.
 
         theta, curve
             Names of the array parameter vectors containing the theta vs. curve
@@ -174,16 +182,22 @@ def moper(
         oper
             Matrix operations:
 
-            * `INVERT` - ``(*MOPER, ParR, Par1, INVERT)``
+            * `INVERT`
+              ``(*MOPER, ParR, Par1, INVERT)``
               Square matrix invert: Inverts the ``n`` x ``n`` matrix in ``Par1``
               into ``ParR``. The matrix must be well conditioned.
 
-              **Warning**: Non-independent or ill-conditioned equations can
-              cause erroneous results. - For large matrices, use the
+              .. warning::
+
+                 Non-independent or ill-conditioned equations can
+                 cause erroneous results.
+
+              For large matrices, use the
               APDL Math operation ``*LSFACTOR`` for efficiency (see APDL
               Math).
 
-            * `MULT` - ``(*MOPER, ParR, Par1, MULT, Par2)``
+            * `MULT`
+              ``(*MOPER, ParR, Par1, MULT, Par2)``
               Matrix multiply: Multiplies ``Par1`` by ``Par2``.  The number of
               rows of ``Par2`` must equal the number of columns of ``Par1`` for
               the operation. If ``Par2`` is input with a number of rows
@@ -192,7 +206,8 @@ def moper(
               number of rows of ``Par2`` equal to the number of columns of
               ``Par1``.
 
-            * `COVAR` - ``(*MOPER, ParR, Par1, COVAR, Par2)``
+            * `COVAR`
+              ``(*MOPER, ParR, Par1, COVAR, Par2)``
               Covariance: The measure of association between two columns
               of the input matrix (``Par1``).  ``Par1``, of size m runs (rows)
               by ``n`` data (columns) is first processed to produce a row
@@ -202,7 +217,8 @@ def moper(
               ``n`` matrix (``ParR``) of covariances (with the variances as the
               diagonal terms).
 
-            * `CORR` - ``(*MOPER, ParR, Par1, CORR, Par2)``
+            * `CORR`
+              ``(*MOPER, ParR, Par1, CORR, Par2)``
               Correlation: The correlation coefficient between two
               variables.  The input matrix (``Par1``), of size m runs (rows)
               by n data (columns), is first processed to produce a row
@@ -212,7 +228,8 @@ def moper(
               ``n`` matrix (``ParR``) of correlation coefficients (with a value
               of 1.0 for the diagonal terms).
 
-            * `SOLV` - ``(*MOPER, ParR, Par1, SOLV, Par2)``
+            * `SOLV`
+              ``(*MOPER, ParR, Par1, SOLV, Par2)``
               Solution of simultaneous equations: Solves the set of ``n``
               equations of n terms of the form ``an_1 x_1 + an_2 x_2 + ... +
               an_n x_n = b_n`` where ``Par1`` contains the matrix of
@@ -226,7 +243,8 @@ def moper(
               APDL Math operation ``*LSFACTOR`` for efficiency (see APDL
               Math).
 
-            * `SORT` - ``(*MOPER, ParR, Par1, SORT, Par2, n1, n2, n3)``
+            * `SORT`
+              ``(*MOPER, ParR, Par1, SORT, Par2, n1, n2, n3)``
               Matrix sort: Sorts matrix ``Par1`` according to sort vector
               ``Par2`` and places the result back in ``Par1``. Rows of ``Par1`` are
               moved to the corresponding positions indicated by the
@@ -238,23 +256,26 @@ def moper(
               row positions (the permutation vector).  Sorting ``Par1``
               according to ``ParR`` should reproduce the initial ordering.
 
-            * `NNEAR` - ``(*MOPER, ParR, Par1, NNEAR, Toler)``
+            * `NNEAR`
+              ``(*MOPER, ParR, Par1, NNEAR, Toler)``
               Nearest Node: Quickly determine all the nodes within a
               specified tolerance of a given array.  ``ParR`` is a vector of
               the nearest selected nodes, or 0 if no nodes are nearer
               than ``Toler``. ``Par1`` is the ``n`` x 3 array of coordinate
               locations. ``Toler`` defaults to 1 and is limited to the
               maximum model size.
 
-            * `ENEAR` - ``(*MOPER, ``ParR``, ``Par1``, ENEAR, Toler)``
+            * `ENEAR`
+              ``(*MOPER, ``ParR``, ``Par1``, ENEAR, Toler)``
               Nearest Element: Quickly determine the elements with
               centroids that are within a specified tolerance of the
               points in a given array. - ``ParR`` is a vector of the nearest
               selected elements, or 0 if no element centroids are nearer
               than ``Toler``. ``Par1`` is the ``n`` x 3 array of coordinate
               locations.
 
-            * `MAP` - ``(*MOPER, ParR, Par1, MAP, Par2, Par3, kDim, --, kOut, LIMIT)``
+            * `MAP`
+              ``(*MOPER, ParR, Par1, MAP, Par2, Par3, kDim, --, kOut, LIMIT)``
               Maps the results from one set of points to another. For
               example, you can map pressures from a CFD analysis onto
               your model for a structural analysis.
@@ -297,14 +318,16 @@ def moper(
               bounds. Results mapping is available from the command line
               only.
 
-            * `INTP` - ``(*MOPER, ParR, Par1, INTP, Par2)``
+            * `INTP`
+              ``(*MOPER, ParR, Par1, INTP, Par2)``
               Finds the elements that contain each point in the array of
               ``n`` x 3 points in ``Par1``. ``Par2`` will contain the set of element
               ID numbers and ``ParR`` will contain their ``n`` x 3 set of
               natural element coordinates (values between -1 and
               1). ``Par1`` must be in global Cartesian coordinates.
 
-            * `SGET` - ``(*MOPER, ParR, Par1, SGET, Par2, Label, Comp)``
+            * `SGET`
+              ``(*MOPER, ParR, Par1, SGET, Par2, Label, Comp)``
               Gets the nodal solution item corresponding to Label and
               Comp (see the PLNSOL command) and interpolates it to the
               given element locations. ``Par1`` contains the ``n`` x 3 array of

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

@@ -58,9 +58,11 @@ def geom(self, k2d="", ndiv="", **kwargs):
         k2d
             Dimensionality key:
 
-            0 - 3-D geometry (default)
+            0
+                3-D geometry (default)
 
-            1 - 2-D geometry (plane or axisymmetric)
+            1
+                2-D geometry (plane or axisymmetric)
 
         ndiv
             Number of divisions in an axisymmetric model.  Used only with K2D =
@@ -82,9 +84,11 @@ def mprint(self, key="", **kwargs):
         key
             Print key:
 
-            0 - Do not print matrices.
+            0
+                Do not print matrices.
 
-            1 - Print matrices.
+            1
+                Print matrices.
 
         Notes
         -----
@@ -129,9 +133,11 @@ def vtype(self, nohid="", nzone="", **kwargs):
         nohid
             Type of viewing procedure:
 
-            0 - Hidden procedure.
+            0
+                Hidden procedure.
 
-            1 - Non-hidden (faster, but less general) procedure.
+            1
+                Non-hidden (faster, but less general) procedure.
 
         nzone
             Number of sampling zones for the hidden procedure (100 maximum for

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

@@ -62,11 +62,14 @@ def radopt(
         solver
             Choice of solver for radiosity calculation:
 
-            0 - Gauss-Seidel iterative solver (default).
+            0
+                Gauss-Seidel iterative solver (default).
 
-            1 - Direct solver.
+            1
+                Direct solver.
 
-            2 - Jacobi solver.
+            2
+                Jacobi solver.
 
         maxiter
             Maximum number of iterations for iterative solver (SOLVER = 0 or
@@ -84,22 +87,20 @@ def radopt(
             Maximum number of flux iterations to be performed according to the
             specified solver type:
 
-            0 - If the FULL solver is specified (THOPT,FULL), convergence criteria are
-                monitored and iterations are performed until convergence
-                occurs. If the QUASI solver is specified (THOPT,QUASI),
-                convergence criteria are ignored and one iteration is
-                performed. This value is the default.
-
-            1, 2, 3, ...N  - If the FULL solver is specified
-                             (THOPT,FULL), convergence criteria are
-                             monitored and iterations are performed
-                             until convergence occurs, or until the
-                             specified number of iterations has been
-                             completed, whichever comes first. If the
-                             QUASI solver is specified (THOPT,QUASI),
-                             convergence criteria are ignored and the
-                             specified number of iterations are
-                             completed.
+            0
+                If the FULL solver is specified (``THOPT,FULL``), convergence
+                criteria are monitored and iterations are performed until
+                convergence occurs. If the QUASI solver is specified
+                (``THOPT,QUASI``), convergence criteria are ignored and one
+                iteration is performed. This value is the default.
+
+            1, 2, 3, ...N
+                If the FULL solver is specified (``THOPT,FULL``), convergence
+                criteria are monitored and iterations are performed until
+                convergence occurs, or until the specified number of iterations
+                has been completed, whichever comes first. If the QUASI solver
+                is specified (``THOPT,QUASI``), convergence criteria are ignored and
+                the specified number of iterations are completed.
 
         Notes
         -----
@@ -232,9 +233,11 @@ def v2dopt(self, geom="", ndiv="", hidopt="", nzone="", **kwargs):
         geom
             Choice of geometry:
 
-            0 - Planar (default).
+            0
+                Planar (default).
 
-            1 - Axisymmetric
+            1
+                Axisymmetric
 
         ndiv
             Number of divisions for axisymmetric geometry (that is, the number
@@ -243,9 +246,11 @@ def v2dopt(self, geom="", ndiv="", hidopt="", nzone="", **kwargs):
         hidopt
             Viewing option:
 
-            0 - Hidden (default).
+            0
+                Hidden (default).
 
-            1 - Non-hidden
+            1
+                Non-hidden
 
         nzone
             Number of zones (that is, the number of rays emanating from a
@@ -266,32 +271,40 @@ def vfsm(self, action="", encl="", opt="", maxiter="", conv="", **kwargs):
         action
             Action to be performed:
 
-            Define - Define a view factor summation (default)
+            Define
+                Define a view factor summation (default)
 
-            Clear - Resets the scaling method to 0 for all
-                    enclosures. All subsequent arguments are ignored.
+            Clear
+                Resets the scaling method to 0 for all
+                enclosures. All subsequent arguments are ignored.
 
-            Status - Outputs the OPT value for each enclosure in the model.
+            Status
+                Outputs the OPT value for each enclosure in the model.
 
         encl
             Previously defined enclosure number for the view factor adjustment.
 
         opt
             Option key:
 
-            0 - The view factor matrix values are not adjusted (default).
+            0
+                The view factor matrix values are not adjusted (default).
 
-            1 - The view factor matrix values are adjusted so that the
+            1
+                The view factor matrix values are adjusted so that the
                 row sum equals 1.0.
 
-            2 - The view factor matrix values are adjusted so that the
+            2
+                The view factor matrix values are adjusted so that the
                 row sum equals 1.0 and the reciprocity relationship is
                 satisfied.
 
-            3 - The view factor matrix values are adjusted so that the
+            3
+                The view factor matrix values are adjusted so that the
                 original row sum is maintained.
 
-            4 - The view factor matrix values are adjusted so that the
+            4
+                The view factor matrix values are adjusted so that the
                 original row sum is maintained and the reciprocity
                 relationship is satisfied.
 
@@ -343,16 +356,20 @@ def vfopt(
         opt
             View factor option:
 
-            NEW - Calculate view factors and write them to a file.
+            NEW
+                Calculate view factors and write them to a file.
 
-            OFF - Do not recalculate view factors it they already exist in the database,
+            OFF
+                Do not recalculate view factors it they already exist in the database,
                   otherwise calculate compute them. This option is the default
                   behavior.
 
-            READ - Read view factors from a binary file. For subsequent SOLVE commands, switch to
+            READ
+                Read view factors from a binary file. For subsequent SOLVE commands, switch to
                    the default option (OFF).
 
-            NONE - Do not write view factors to a file.
+            NONE
+                Do not write view factors to a file.
 
         fname
             File name for view factor matrix. Default = Jobname.
@@ -367,16 +384,31 @@ def vfopt(
         filetype
             View factor file type:
 
-            BINA - Binary (default).
+            BINA
+                Binary (default).
 
-            ASCI - ASCII.
+            ASCI
+                ASCII.
 
         fileformat
             Format for the specified Filetype:
 
-            Binary files (Filetype = BINA): - 0
+            Binary files (Filetype = BINA):
 
-            No compression. (View factor file size may be very large.) - 1
+            0
+                No compression. (View factor file size may be very large.)
+
+            1
+                Zeroes are compressed out. (Useful for large models to reduce
+                the view factor file size.)
+
+            ASCII files (Filetype = ASCI):
+
+            0
+                10F7.4 (low precision, lower accuracy).
+
+            1
+                7F11.8 (high precision, higher accuracy).
 
         Notes
         -----