Fixed Docstring #3970 #3985

DaveTwyman · 2023-12-14T14:05:46Z

Close #3970

ansys-reviewer-bot · 2023-12-14T14:05:51Z

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

@ansys-reviewer-bot review

codecov · 2023-12-14T14:26:32Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (0e2e1c2) 81.41% compared to head (9b29f46) 81.41%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3985   +/-   ##
=======================================
  Coverage   81.41%   81.41%           
=======================================
  Files         182      182           
  Lines       63306    63306           
=======================================
  Hits        51542    51542           
  Misses      11764    11764

pyaedt/maxwell.py

Co-authored-by: Maxime Rey <[email protected]>

gmalinve · 2023-12-15T14:09:54Z

@MaxJPRey PR opened for training purposes :)
I'm pretty sure someone from the team will take care of this and will fix all the issues.
Remember to fix also the SetupTemplateMaxwell.rst mentioned in the linked issue.
@IreneWoyna @DaveTwyman @tizianrot @anur7

gmalinve

@IreneWoyna @tizianrot @DaveTwyman could someone pick this up please?
We need to finish editing the docstring + the SetupMaxwellTemplate.rst file in the doc.
If needed please ping me :)

DaveTwyman · 2023-12-20T08:52:31Z

@IreneWoyna @tizianrot @DaveTwyman could someone pick this up please? We need to finish editing the docstring + the SetupMaxwellTemplate.rst file in the doc. If needed please ping me :)

Yes, I can finish this off, one of the checks is failing though, I'll message you

Samuelopez-ansys

Please commit these changes

pyaedt/maxwell.py

gmalinve · 2023-12-20T08:59:12Z

@DaveTwyman checks fail because we didn't finish to work on the docstring and some indentations are wrong

Extra Line Co-authored-by: Samuel Lopez <[email protected]>

Unneeded Indentation Co-authored-by: Samuel Lopez <[email protected]>

Co-authored-by: Samuel Lopez <[email protected]>

for more information, see https://pre-commit.ci

pyaedt/maxwell.py

DaveTwyman

Looks ok, I'll add the missing Maxwell solver types as well

MIssing Maxwell solver types added

Spread Maxwell solver names over two lines to obey line length limit

for more information, see https://pre-commit.ci

DaveTwyman

Looks Good

pyaedt/maxwell.py

Hi, There was no deep thought behind the dash next to the colon. I've removed it, sounds like text will now be consistent with other parts of docs Co-authored-by: SMoraisAnsys <[email protected]>

gmalinve · 2023-12-21T09:52:10Z

@DaveTwyman just a suggestion and based on the training sessions we had, it's better to put a meaningful comment for each commit you make. So far you have pushed all the commits with the same message "update maxwell.py" .

It's not a problem but it's better to have a short message related to the change in your commit so it's easier for the review process :)

pyaedt/maxwell.py

The word 'Depending' was proposed instead of 'Based' Co-authored-by: Kathy Pippert <[email protected]>

Solvers no longer grouped in terms of Magnetic and Electric solvers but now alphabetized and with double backticks and quotation marks applied. Co-authored-by: Kathy Pippert <[email protected]>

gmalinve · 2023-12-22T07:12:40Z

doc/source/API/SetupTemplatesMaxwell.rst


 .. pprint:: pyaedt.modules.SetupTemplates.MaxwellTransient
 .. pprint:: pyaedt.modules.SetupTemplates.Magnetostatic
 .. pprint:: pyaedt.modules.SetupTemplates.Electrostatic
 .. pprint:: pyaedt.modules.SetupTemplates.EddyCurrent
 .. pprint:: pyaedt.modules.SetupTemplates.ElectricTransient
-
+.. pprint:: pyaedt.modules.SetupTemplates.ACConduction


@DaveTwyman please have a look at the doc build checks that fails. It says that in SetupTemplates there are no templates named "ACConduction" or "DCConduction".

@gmalinve , Ok, they can be added in the future. Maybe at the same time as adjusting all the other solver templates that reference HFSS. I've removed them for now

@DaveTwyman did you remove them?

@gmalinve , I deleted the two lines in Pycharm and then hit commit.

@DaveTwyman as you can see these lines are still here, let me try to do it on my side.

SMoraisAnsys · 2023-12-22T07:49:07Z

DaveTwyman

@DaveTwyman if you ever want to try to rewrite your branch history (e.g. changing commit names, squashing commits, do not hesitate to contact me)

DaveTwyman

Removed reference to AC and DC Conduction templates

DaveTwyman · 2023-12-22T08:38:16Z

doc/source/API/SetupTemplatesMaxwell.rst


 .. pprint:: pyaedt.modules.SetupTemplates.MaxwellTransient
 .. pprint:: pyaedt.modules.SetupTemplates.Magnetostatic
 .. pprint:: pyaedt.modules.SetupTemplates.Electrostatic
 .. pprint:: pyaedt.modules.SetupTemplates.EddyCurrent
 .. pprint:: pyaedt.modules.SetupTemplates.ElectricTransient
-
+.. pprint:: pyaedt.modules.SetupTemplates.ACConduction


@gmalinve , Ok, they can be added in the future. Maybe at the same time as adjusting all the other solver templates that reference HFSS. I've removed them for now

DaveTwyman

Removing this makes sense, I now see this is the maxwell.py file and not the rst file

Fixed Docstring #3970

731a92a

DaveTwyman requested a review from gmalinve December 14, 2023 14:05

DaveTwyman self-assigned this Dec 14, 2023

github-actions bot added the bug Something isn't working label Dec 14, 2023

MaxJPRey reviewed Dec 15, 2023

View reviewed changes

pyaedt/maxwell.py Outdated Show resolved Hide resolved

Update pyaedt/maxwell.py

cab3a8e

Co-authored-by: Maxime Rey <[email protected]>

gmalinve added 2 commits December 18, 2023 13:47

Merge branch 'main' into fix/doc3970

171132e

Merge branch 'main' into fix/doc3970

4e2c0fe

gmalinve requested changes Dec 20, 2023

View reviewed changes

Merge branch 'main' into fix/doc3970

ab63597

Samuelopez-ansys reviewed Dec 20, 2023

View reviewed changes

pyaedt/maxwell.py Outdated Show resolved Hide resolved

pyaedt/maxwell.py Outdated Show resolved Hide resolved

pyaedt/maxwell.py Outdated Show resolved Hide resolved

DaveTwyman and others added 4 commits December 20, 2023 09:56

Update pyaedt/maxwell.py

e35a28c

Extra Line Co-authored-by: Samuel Lopez <[email protected]>

Update pyaedt/maxwell.py

ebd876f

Unneeded Indentation Co-authored-by: Samuel Lopez <[email protected]>

Update pyaedt/maxwell.py

bef6358

Co-authored-by: Samuel Lopez <[email protected]>

[pre-commit.ci] auto fixes from pre-commit.com hooks

add25ce

for more information, see https://pre-commit.ci

gmalinve reviewed Dec 20, 2023

View reviewed changes

pyaedt/maxwell.py Outdated Show resolved Hide resolved

gmalinve reviewed Dec 20, 2023

View reviewed changes

pyaedt/maxwell.py Show resolved Hide resolved

DaveTwyman commented Dec 20, 2023

View reviewed changes

DaveTwyman and others added 3 commits December 20, 2023 11:05

Update maxwell.py

0e620b6

MIssing Maxwell solver types added

Update maxwell.py

7e489cf

Spread Maxwell solver names over two lines to obey line length limit

[pre-commit.ci] auto fixes from pre-commit.com hooks

e7bbe18

for more information, see https://pre-commit.ci

DaveTwyman commented Dec 20, 2023

View reviewed changes

DaveTwyman requested a review from gmalinve December 20, 2023 11:55

Merge branch 'main' into fix/doc3970

a474c4b

SMoraisAnsys reviewed Dec 21, 2023

View reviewed changes

pyaedt/maxwell.py Outdated Show resolved Hide resolved

Update pyaedt/maxwell.py

5cc1f3a

Hi, There was no deep thought behind the dash next to the colon. I've removed it, sounds like text will now be consistent with other parts of docs Co-authored-by: SMoraisAnsys <[email protected]>

PipKat reviewed Dec 21, 2023

View reviewed changes

pyaedt/maxwell.py Outdated Show resolved Hide resolved

PipKat reviewed Dec 21, 2023

View reviewed changes

pyaedt/maxwell.py Outdated Show resolved Hide resolved

DaveTwyman and others added 8 commits December 21, 2023 20:38

Update pyaedt/maxwell.py

2ea9761

The word 'Depending' was proposed instead of 'Based' Co-authored-by: Kathy Pippert <[email protected]>

Merge branch 'main' into fix/doc3970

88a5d42

Update pyaedt/maxwell.py

913a68c

Solvers no longer grouped in terms of Magnetic and Electric solvers but now alphabetized and with double backticks and quotation marks applied. Co-authored-by: Kathy Pippert <[email protected]>

Fixed Docstring #3970 and removed reference to HFSS

28d9453

Fixed Docstring #3970 and removed reference to HFSS

5ce3b2d

Title style reverted to Sentence-style capitalization.

a4fc1d4

fix doc

6655ecf

fix doc

728d61f

gmalinve reviewed Dec 22, 2023

View reviewed changes

Reference to AC and DC Conduction templates removed

a93f9dc

DaveTwyman commented Dec 22, 2023

View reviewed changes

DaveTwyman added 2 commits December 22, 2023 08:40

Merge branch 'main' into fix/doc3970

1f97d9b

Merge branch 'main' into fix/doc3970

9dba113

DaveTwyman commented Dec 22, 2023

View reviewed changes

DaveTwyman added 2 commits December 22, 2023 11:02

Merge remote-tracking branch 'origin/fix/doc3970' into fix/doc3970

00be6f4

remove blank line

9b29f46

gmalinve approved these changes Dec 22, 2023

View reviewed changes

DaveTwyman merged commit f0af285 into main Dec 22, 2023
12 checks passed

DaveTwyman deleted the fix/doc3970 branch December 22, 2023 11:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixed Docstring #3970 #3985

Fixed Docstring #3970 #3985

DaveTwyman commented Dec 14, 2023 •

edited

Loading

ansys-reviewer-bot bot commented Dec 14, 2023

codecov bot commented Dec 14, 2023 •

edited

Loading

gmalinve commented Dec 15, 2023 •

edited

Loading

gmalinve left a comment

DaveTwyman commented Dec 20, 2023

Samuelopez-ansys left a comment

gmalinve commented Dec 20, 2023

DaveTwyman left a comment

DaveTwyman left a comment

gmalinve commented Dec 21, 2023 •

edited

Loading

gmalinve Dec 22, 2023

DaveTwyman Dec 22, 2023

gmalinve Dec 22, 2023

DaveTwyman Dec 22, 2023

gmalinve Dec 22, 2023

SMoraisAnsys commented Dec 22, 2023

DaveTwyman left a comment

DaveTwyman Dec 22, 2023

DaveTwyman left a comment

Fixed Docstring #3970 #3985

Fixed Docstring #3970 #3985

Conversation

DaveTwyman commented Dec 14, 2023 • edited Loading

ansys-reviewer-bot bot commented Dec 14, 2023

codecov bot commented Dec 14, 2023 • edited Loading

Codecov Report

gmalinve commented Dec 15, 2023 • edited Loading

gmalinve left a comment

Choose a reason for hiding this comment

DaveTwyman commented Dec 20, 2023

Samuelopez-ansys left a comment

Choose a reason for hiding this comment

gmalinve commented Dec 20, 2023

DaveTwyman left a comment

Choose a reason for hiding this comment

DaveTwyman left a comment

Choose a reason for hiding this comment

gmalinve commented Dec 21, 2023 • edited Loading

gmalinve Dec 22, 2023

Choose a reason for hiding this comment

DaveTwyman Dec 22, 2023

Choose a reason for hiding this comment

gmalinve Dec 22, 2023

Choose a reason for hiding this comment

DaveTwyman Dec 22, 2023

Choose a reason for hiding this comment

gmalinve Dec 22, 2023

Choose a reason for hiding this comment

SMoraisAnsys commented Dec 22, 2023

DaveTwyman left a comment

Choose a reason for hiding this comment

DaveTwyman Dec 22, 2023

Choose a reason for hiding this comment

DaveTwyman left a comment

Choose a reason for hiding this comment

DaveTwyman commented Dec 14, 2023 •

edited

Loading

codecov bot commented Dec 14, 2023 •

edited

Loading

gmalinve commented Dec 15, 2023 •

edited

Loading

gmalinve commented Dec 21, 2023 •

edited

Loading