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

Lao polynomial fixes #3634

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

Lao polynomial fixes #3634

wants to merge 5 commits into from

Conversation

OceanNuclear
Copy link
Contributor

@OceanNuclear OceanNuclear commented Oct 10, 2024

Linked Issues

Closes #3625

Description

Fixed all issues related to Lao polynomials, including both Documentation and Implementation. Clarified the documentation as well.

Interface Changes

N/A

Checklist

I confirm that I have completed the following checks:

  • Tests run locally and pass pytest for tests/equilibria/test_equilibrium.py and tests/equilibria/fem_fixed_boundary/test_fem_magnetostatic_2D.py
  • Code quality checks run locally and pass pre-commit run --from-ref develop --to-ref HEAD
  • Documentation built locally and checked sphinx-build -W documentation/source documentation/build

📚 Documentation preview 📚: https://bluemira--3634.org.readthedocs.build/en/3634/

…ialRight. Saved in here so that we can re-access in the git history.
…he text is also referring to a non-existent section ('in the following'), so I've removed that as well.
…, so that we don't end up confusingly triply-defining the same function (g(psi,alpha)).
@OceanNuclear OceanNuclear requested review from a team as code owners October 10, 2024 19:05
Copy link

sonarcloud bot commented Oct 10, 2024

Copy link

codecov bot commented Oct 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.39%. Comparing base (d330bcd) to head (df4a549).

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #3634      +/-   ##
===========================================
+ Coverage    76.37%   76.39%   +0.01%     
===========================================
  Files          230      230              
  Lines        26710    26710              
===========================================
+ Hits         20401    20406       +5     
+ Misses        6309     6304       -5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@je-cook je-cook added bug Something isn't working equilibria Tasks relating to the equilibria module labels Oct 11, 2024
@OceanNuclear
Copy link
Contributor Author

For Matti's benefit/to save some compile time, this is a screenshot of the HTML file created by sphinx corresponding to the .rst file that I changed:
Before:
image
After:
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working equilibria Tasks relating to the equilibria module
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Lao polynomial equation issues in equilibria.rst and implementation
3 participants