Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docstring for MeshRegion class. #3785

Merged
merged 2 commits into from
Oct 23, 2023
Merged

Conversation

lorenzovecchietti
Copy link
Contributor

Close #3721.

@ansys-reviewer-bot
Copy link
Contributor

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

@ansys-reviewer-bot review

@codecov
Copy link

codecov bot commented Oct 23, 2023

Codecov Report

Merging #3785 (504ffb3) into main (44d83df) will increase coverage by 0.00%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #3785   +/-   ##
=======================================
  Coverage   81.07%   81.07%           
=======================================
  Files         180      180           
  Lines       61977    61977           
=======================================
+ Hits        50249    50250    +1     
+ Misses      11728    11727    -1     

@lorenzovecchietti
Copy link
Contributor Author

As commented here:

I added a docstring for the MeshRegion class.
So when a user creates the mesh region, he can see the different attributes and their meaning with the help command. I also explicitly wrote down available options for particular arguments, like the one related to this issue.

The alternative was to create setter and getter, but this seems harder to maintain with little benefit.

@lorenzovecchietti lorenzovecchietti merged commit 99fb555 into main Oct 23, 2023
12 checks passed
@lorenzovecchietti lorenzovecchietti deleted the enhancement/icepak_meshing branch October 23, 2023 11:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve IcepakMesh class to allow setting 2D MLM plane
2 participants