Skip to content

DOCS: improving documentation of Maxwell class#6150

Merged
anur7 merged 60 commits into
mainfrom
doc/maxwell_doc
Jul 14, 2025
Merged

DOCS: improving documentation of Maxwell class#6150
anur7 merged 60 commits into
mainfrom
doc/maxwell_doc

Conversation

@anur7

@anur7 anur7 commented May 13, 2025

Copy link
Copy Markdown
Contributor

Description

Adding examples and improving docstring of Maxwell's methods.

Issue linked

#6136

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).

@anur7 anur7 self-assigned this May 13, 2025
@anur7 anur7 added the documentation Improvements or additions to documentation label May 13, 2025
@ansys-reviewer-bot

Copy link
Copy Markdown
Contributor

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

@ansys-reviewer-bot review

@Samuelopez-ansys

Copy link
Copy Markdown
Member

@anur7 Please could you be more specific in the PR Title? It is important because if you are going to change only one method, then I would change the title to "Improve xxxx method documentation"

And then please add some description.

Thank you!

@codecov

codecov Bot commented May 13, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.39%. Comparing base (6d6d39f) to head (8e2eca8).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #6150   +/-   ##
=======================================
  Coverage   85.39%   85.39%           
=======================================
  Files         175      175           
  Lines       66157    66157           
=======================================
+ Hits        56492    56498    +6     
+ Misses       9665     9659    -6     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@anur7 anur7 changed the title DOCS: improving Maxwell documentation DOCS: improving documentation of Maxwell class May 13, 2025
@anur7 anur7 requested a review from gmalinve May 19, 2025 15:47
@anur7 anur7 requested review from jvela018 and nunesanderson May 22, 2025 17:36

@gmalinve gmalinve left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@anur7 @nunesanderson I trust all examples are running smoothly as I didnìt have time to test them all. I also trust that all sentences "it works only in..." a specific solver are also correct as I didn't check upon every of them.

Comment thread src/ansys/aedt/core/maxwell.py Outdated
Comment thread src/ansys/aedt/core/maxwell.py Outdated
Comment thread src/ansys/aedt/core/maxwell.py
Comment thread src/ansys/aedt/core/maxwell.py Outdated
Comment thread src/ansys/aedt/core/maxwell.py Outdated
Comment thread src/ansys/aedt/core/maxwell.py Outdated
Comment thread src/ansys/aedt/core/maxwell.py Outdated
Comment thread src/ansys/aedt/core/maxwell.py Outdated
Comment thread src/ansys/aedt/core/maxwell.py Outdated
Comment thread src/ansys/aedt/core/maxwell.py
nunesanderson
nunesanderson previously approved these changes Jul 1, 2025
Comment thread src/ansys/aedt/core/maxwell.py
Comment thread src/ansys/aedt/core/maxwell.py
Co-authored-by: Giulia Malinverno <103059376+gmalinve@users.noreply.github.com>
@anur7 anur7 requested review from gmalinve and nunesanderson July 8, 2025 14:22
Comment thread src/ansys/aedt/core/maxwell.py Outdated
@anur7 anur7 requested a review from SMoraisAnsys July 11, 2025 14:27
nunesanderson
nunesanderson previously approved these changes Jul 11, 2025
@nunesanderson

Copy link
Copy Markdown
Contributor

@gmalinve I think this PR is ready to be merged. The example with harmonic force is working properly.
Would you mind checking whether Abdun can merge?
There seems to be an issue with the codecov.
Thank you!
@anur7

gmalinve
gmalinve previously approved these changes Jul 14, 2025
@anur7 anur7 merged commit f4de059 into main Jul 14, 2025
37 checks passed
@anur7 anur7 deleted the doc/maxwell_doc branch July 14, 2025 16:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants