fix(plotting): Improve interface of the plotting class.

[AlejandroFernandezLuces]

Description

This PR improves the usability of some methods in the plotting class. This class was meant to be used inside eplot, vplot.. functions, but since some use cases involve using it standalone, I improved it's usability and documentation.

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)

[ansys-reviewer-bot]

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.37%. Comparing base (9f5e4e9) to head (6718ab3).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3702      +/-   ##
==========================================
- Coverage   88.38%   88.37%   -0.01%     
==========================================
  Files         187      187              
  Lines       14742    14751       +9     
==========================================
+ Hits        13029    13036       +7     
- Misses       1713     1715       +2     

🚀 New features to boost your workflow:

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

[AlejandroFernandezLuces]

@clatapie This PR fixes your original issue. I'm unsure if more issues will arise, since plots are not throwing errors and I do not know how plots should look like. I would need to compare results from the original examples to what we have right now for further debugging.

From my point of view, we can either merge this PR and we can add more fixes as issues arise, or you can install this branch in your local and ping me when something does not look as expected. What do you think?

[clatapie]

Thanks for fixing the error @AlejandroFernandezLuces!
I will use this branch in the PyMAPDL-Example PR and check the documentation output so that we will have it tested with a broader range of examples

[germa89]

@AlejandroFernandezLuces any update on this? Is this planned?

[AlejandroFernandezLuces]

This is pending @clatapie PR in ansys/pymapdl-examples#281. This PR intends to fix some issues that arise in that PR. @clatapie let me know if you need any help 🙂

[clatapie]

I confirm that the issue has correctly been addressed with this fix. Thank you @AlejandroFernandezLuces!

[germa89]

This PR needs a bit more coverage before being merged.

[germa89]

Please increase the coverage before merging. Plotting is an important feature and needs to be as much tested as possible.

[AlejandroFernandezLuces]

@germa89 increased coverage to 100%. I'm seeing an issue with the CI in this PR, it seems that there is a required job that does not exist:

Is this an specific problem for this PR or is it general?

[germa89]

LGTM!

[germa89]

@germa89 increased coverage to 100%. I'm seeing an issue with the CI in this PR, it seems that there is a required job that does not exist:

Is this an specific problem for this PR or is it general?

@AlejandroFernandezLuces it was my fault. :)