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

FIX: Readibility improvements #5544

Merged
merged 8 commits into from
Dec 12, 2024
Merged

FIX: Readibility improvements #5544

merged 8 commits into from
Dec 12, 2024

Conversation

maxcapodi78
Copy link
Collaborator

Readibility improvements

Description

Fixed many docstrings errors!
modeler of PostCommon class has been made internal.

Issue linked

#5543

Checklist

  • I have tested my changes locally.
  • I have added necessary documentation or updated existing documentation.
  • I have followed the coding style guidelines of this project.
  • I have added appropriate tests (unit, integration, system).
  • I have reviewed my changes before submitting this pull request.
  • I have linked the issue or issues that are solved by the PR if any.
  • I have agreed with the Contributor License Agreement (CLA).

modeler of PostCommon class has been made internal
@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

Copy link
Collaborator

@SMoraisAnsys SMoraisAnsys left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the goal is to make modeler internal, could we make _modeler an attribute of the class instead of a property ? See my comment

src/ansys/aedt/core/visualization/post/common.py Outdated Show resolved Hide resolved
Copy link
Collaborator

@SMoraisAnsys SMoraisAnsys left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You need to modify a signature to use List instead of list. To make that work, you also need to add from typing import List

src/ansys/aedt/core/application/analysis.py Outdated Show resolved Hide resolved
…s passes and set Theta and Phi to All in case they are not defined as variaton dictionary.
…s passes and set Theta and Phi to All in case they are not defined as variaton dictionary.
Copy link

codecov bot commented Dec 9, 2024

Codecov Report

Attention: Patch coverage is 80.43478% with 9 lines in your changes missing coverage. Please review.

Project coverage is 85.00%. Comparing base (4ab7475) to head (e4f3a0a).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5544      +/-   ##
==========================================
- Coverage   85.00%   85.00%   -0.01%     
==========================================
  Files         151      151              
  Lines       60761    60761              
==========================================
- Hits        51652    51649       -3     
- Misses       9109     9112       +3     

@maxcapodi78 maxcapodi78 merged commit 7ba1650 into main Dec 12, 2024
42 of 43 checks passed
@maxcapodi78 maxcapodi78 deleted the improve_docstrings branch December 12, 2024 08:43
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.

3 participants