(Fix-It Week) Updated the documentation of the `to_mgrid` function
Summary
This PR updates the documentation of the to_mgrid method of MagneticField objects. The changes to the documentation describe how the mgrid file is used by free boundary VMEC, and how to set the arguments of the function. The discuss is largely taken from the vmec wiki.
Screenshots
Tests No unit tests needed.
Updated documentation and uploaded new screenshot
Codecov Report
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 91.98%. Comparing base (
f0f0ec4) to head (5e6b02c). Report is 155 commits behind head on master.
Additional details and impacted files
@@ Coverage Diff @@
## master #503 +/- ##
==========================================
- Coverage 92.25% 91.98% -0.28%
==========================================
Files 82 82
Lines 16015 16015
==========================================
- Hits 14775 14731 -44
- Misses 1240 1284 +44
| Flag | Coverage Δ | |
|---|---|---|
| unittests | 91.98% <ø> (-0.28%) |
:arrow_down: |
Flags with carried forward coverage won't be shown. Click here to find out more.
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
:rocket: New features to boost your workflow:
- :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
Updated documentation to reflect the capability with respect to the number of current groups.
Screenshot of to_mgrid doc
Screenshots of MGrid doc