fix: improve code quality and numpydoc documentation (#4125)

* fix: improve code quality and numpydoc documentation

- Fix typo in _get_file_name docstring parameter description
- Replace bare except clauses with specific OSError exceptions in launcher.py
- Remove duplicate logging statement in licensing.py, use LOG.info instead
- Add missing Parameters and Returns sections to Information class methods
- Fix GL02 docstring formatting issues (closing quotes placement)
- Add Returns section to convert.py format_using_autopep8 method

* fix: enable additional docstring checks for improved documentation quality

* Apply suggestions from code review

Co-authored-by: Copilot <[email protected]>

* chore: adding changelog file 4125.fixed.md [dependabot-skip]

* fix: enhance docstrings for MAPDL information properties to include return types

* fix: improve docstrings for GrpcError to include parameters and return types

* fix: update docstrings in convert.py to include parameters and return types

* fix: enhance docstrings in mapdl_extended.py to include parameters and return types

* chore: adding changelog file 4125.miscellaneous.md [dependabot-skip]

* fix: GL02 numpydoc issue

* fix: some PR01 issues.

* fix: enhance docstrings for return values in multiple classes

* fix: add test for title property in MapdlInfo class

* fix: all issues in information

---------

Co-authored-by: Copilot <[email protected]>
Co-authored-by: pyansys-ci-bot <[email protected]>

Author: 3 people

doc/changelog.d/4125.miscellaneous.md

@@ -0,0 +1 @@
+Fix: improve code quality and numpydoc documentation

doc/post_process_tex.py

@@ -1,7 +1,6 @@
 """Validate the PNG images in the build/latex/ directory
 
-Removes invalid PNGs (probably GIF)
-
+Removes invalid PNGs (probably GIF).
 """
 
 from glob import glob

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

@@ -1125,7 +1125,6 @@ def starvput(
            * - ETAB
              - Lab
              - Any user-defined element table label ( :ref:`etable` ).
-
         """
         command = (
             f"*VPUT,{parr},{entity},{entnum},{item1},{it1num},{item2},{it2num},{kloop}"

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

@@ -1265,8 +1265,6 @@ def lsdump(self, enginename: str = "", filename: str = "", **kwargs):
         :ref:`lsrestore` command.
 
         A BCS Sparse Solver can be dumped only if uses the ``INCORE`` memory option (see :ref:`bcsoption` ).
-
-
         """
         command = f"*LSDUMP,{enginename},{filename}"
         return self.run(command, **kwargs)
@@ -1427,8 +1425,6 @@ def lsrestore(self, enginename: str = "", filename: str = "", **kwargs):
 
         Restores a previously dumped Linear Solver (see the :ref:`lsdump` command). This Linear Solver can
         be used to solve a linear system using the :ref:`lsbac` command.
-
-
         """
         command = f"*LSRESTORE,{enginename},{filename}"
         return self.run(command, **kwargs)

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

@@ -2944,7 +2944,6 @@ def get(
            * - STAT
              - ``Element Number``
              - Status of the element: 0 = uncracked, 1 = cracked
-
         """
         command = f"*GET,{par},{entity},{entnum},{item1},{it1num},{item2},{it2num}"
         return self.run(command, **kwargs)
@@ -4766,7 +4765,6 @@ def starvget(
            * - EMF
              -
              - Electromotive force drop
-
         """
         command = (
             f"*VGET,{parr},{entity},{entnum},{item1},{it1num},{item2},{it2num},{kloop}"

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

@@ -511,7 +511,6 @@ def cmwrite(self, fname: str = "", ext: str = "", fmat: str = "", **kwargs):
             * ``BLOCKED`` - Blocked format. This format allows faster reading of the file.
 
             * ``UNBLOCKED`` - Unblocked format.
-
         """
         command = f"CMWRITE,{fname},{ext},,,{fmat}"
         return self.run(command, **kwargs)

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

@@ -240,7 +240,6 @@ def asel(
            * - ACCA
              -
              - Concatenated areas (selects only areas that were created by area concatenation ( :ref:`accat` )).
-
         """
         command = f"ASEL,{type_},{item},{comp},{vmin},{vmax},{vinc},{kswp}"
         return self.run(command, **kwargs)
@@ -652,7 +651,6 @@ def esel(
            * - ETAB
              - ``Lab``
              - Any user-defined element table label ( :ref:`etable` ).
-
         """
         command = f"ESEL,{type_},{item},{comp},{vmin},{vmax},{vinc},{kabs}"
         return self.run(command, **kwargs)
@@ -935,7 +933,6 @@ def ksel(
            * - ESYS
              -
              - Element coordinate system associated with the keypoint.
-
         """
         command = f"KSEL,{type_},{item},{comp},{vmin},{vmax},{vinc},{kabs}"
         return self.run(command, **kwargs)
@@ -1166,7 +1163,6 @@ def lsel(
            * - LCCA
              -
              - Concatenated lines (selects only lines that were created by concatenation ( :ref:`lccat` )).
-
         """
         command = f"LSEL,{type_},{item},{comp},{vmin},{vmax},{vinc},{kswp}"
         return self.run(command, **kwargs)
@@ -2056,7 +2052,6 @@ def vsel(
            * - ESYS
              -
              - Element coordinate system associated with the volume.
-
         """
         command = f"VSEL,{type_},{item},{comp},{vmin},{vmax},{vinc},{kswp}"
         return self.run(command, **kwargs)

src/ansys/mapdl/core/_commands/graphics/set_up.py

@@ -1000,7 +1000,6 @@ def jpeg(self, kywrd: str = "", opt: str = "", **kwargs):
 
             * ``1,0`` - If ``Kywrd`` = TMOD, the values 1 and 0 determine whether bitmap (1) or stroke text (0)
               fonts will be used
-
         """
         command = f"JPEG,{kywrd},{opt}"
         return self.run(command, **kwargs)
@@ -1192,7 +1191,6 @@ def pngr(self, kywrd: str = "", opt: str = "", val: int | str = "", **kwargs):
 
             * ``1-9`` - Use this value to specify a specific compression level. 1 is the lowest compression
               level (fastest) and 9 is the highest compression level (slowest).
-
         """
         command = f"PNGR,{kywrd},{opt},{val}"
         return self.run(command, **kwargs)
@@ -1494,7 +1492,6 @@ def tiff(self, kywrd: str = "", opt: str = "", **kwargs):
 
             * ``1, 0`` - If ``Kywrd`` = TMOD, the values 1 and 0 determine whether bitmap (1) or stroke text (0)
               fonts will be used
-
         """
         command = f"TIFF,{kywrd},{opt}"
         return self.run(command, **kwargs)

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

@@ -22,7 +22,6 @@
 
 """These commands may be run by PyMAPDL, but are not supported from a
 user-context.
-
 """
 
 

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

@@ -19,7 +19,6 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
-
 """Inquire undocumented functions"""
 
 
@@ -374,7 +373,6 @@ def lsinqr(self, line, key, pname="__tmpvar__", **kwargs):
 
             For key not equal to 1 returned data is based
             on setting of key.
-
         """
         return self.run(f"{pname} = lsinqr({line}, {key})", **kwargs)
 
@@ -580,7 +578,6 @@ def rlinqr(self, nreal, key, pname="__tmpvar__", **kwargs):
         -------
         int or str
             The returned value of ``rlinqr`` is based on setting of key.
-
         """
         return self.run(f"{pname} = rlinqr({nreal}, {key})", **kwargs)
 
@@ -762,7 +759,6 @@ def cpinqr(self, ncp, key, pname="__tmpvar__", **kwargs):
         -------
         int or str
             The returned value of ``cpinqr`` is based on setting of key.
-
         """
         return self.run(f"{pname} = cpinqr({ncp}, {key})", **kwargs)
 
@@ -1053,7 +1049,6 @@ def mpinqr(self, mat, iprop, key, pname="__tmpvar__", **kwargs):
         +----------+-----+----------+-----+----------+-----+----------+-----+----------+-----+----------+-----+
 
         see :meth:`TB <ansys.mapdl.core.Mapdl.tb>` command for more information.
-
         """
         return self.run(f"{pname} = mpinqr({mat}, {iprop}, {key})", **kwargs)
 
@@ -1350,7 +1345,6 @@ def erinqr(self, key, pname="__tmpvar__", **kwargs):
         -------
         int or str
             Value corresponding to key.
-
         """
         return self.run(f"{pname} = erinqr({key})", **kwargs)
 
@@ -1423,6 +1417,5 @@ def wrinqr(self, key, pname="__tmpvar__", **kwargs):
         -------
         int or str
             The value corresponding to key.
-
         """
         return self.run(f"{pname} = wrinqr({key})", **kwargs)