refactor: adding type hints to result.py

[germa89]

Description

As the title. Adding type hints and checking numpydoc.

Issue linked

NA

Checklist

• I have visited and read Develop PyMAPDL.
• I have tested my changes locally
• I have added necessary documentation or updated existing documentation.
• I have followed the PyMAPDL coding style guidelines.
• I have added appropriate unit tests that also ensure the minimal coverage criteria.
• I have reviewed my changes before submitting this pull request.
• I have linked the issue or issues that are solved to the PR if any.
• I have assigned this PR to myself.
• I have marked this PR as draft if it is not ready to be reviewed yet.
• I have made sure that the title of my PR follows Commit naming conventions (e.g. feat: adding new MAPDL command)

[germa89]

@pyansys-ci-bot LGTM.

[pyansys-ci-bot]

✅ Approving this PR because germa89 said so in here 😬

[Copilot]

Pull Request Overview

This PR adds comprehensive type hints and updates documentation for the result.py file, improving code maintainability and developer experience. The changes include adding TypeAlias definitions for commonly used types, enhancing method signatures with proper type annotations, and updating docstrings to follow numpydoc conventions.

Key changes include:

• Addition of type aliases for common parameter types like Rnum, Nodes, Elements, and ReturnData
• Comprehensive type hints for all methods and properties
• Enhanced docstrings with proper parameter and return type documentation

Comments suppressed due to low confidence (2)

src/ansys/mapdl/core/reader/result.py:47

• [nitpick] The type alias 'Rnum' is ambiguous and doesn't clearly indicate what it represents. Consider a more descriptive name like 'ResultNumber' or 'ResultIndex'.

Rnum: TypeAlias = Union[int, float, Iterable[int], Iterable[float], None]

src/ansys/mapdl/core/reader/result.py:947

• [nitpick] The variable name 'entity_type_' with trailing underscore is unclear. Consider a more descriptive name like 'normalized_entity_type' or 'formatted_entity_type'.

            entity_type_ = entity_type.title()  # Sanity check

[codecov]

Codecov Report

❌ Patch coverage is 90.62500% with 9 lines in your changes missing coverage. Please review.
✅ Project coverage is 91.32%. Comparing base (db31b73) to head (fab2351).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4133      +/-   ##
==========================================
- Coverage   91.35%   91.32%   -0.03%     
==========================================
  Files         189      189              
  Lines       15650    15667      +17     
==========================================
+ Hits        14297    14308      +11     
- Misses       1353     1359       +6     

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.