Skip to content

DOCS: improving documentation of Maxwell class #6150

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

Draft
wants to merge 20 commits into
base: main
Choose a base branch
from
Draft

Conversation

anur7
Copy link
Contributor

@anur7 anur7 commented May 13, 2025

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
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
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!

Copy link

codecov bot commented May 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 18.61%. Comparing base (bf92f55) to head (7986040).

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #6150       +/-   ##
===========================================
- Coverage   81.68%   18.61%   -63.07%     
===========================================
  Files         170      170               
  Lines       64119    64119               
===========================================
- Hits        52376    11937    -40439     
- Misses      11743    52182    +40439     
🚀 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 nunesanderson and jvela018 May 22, 2025 17:36
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.

3 participants