Visitar URL original
Add Lundquist number by TrestanSimon · Pull Request #1642 · PlasmaPy/PlasmaPy · GitHub
Skip to content

Add Lundquist number - #1642

Merged
StanczakDominik merged 16 commits into
PlasmaPy:mainfrom
TrestanSimon:Add_Lundquist_number
Aug 23, 2022
Merged

StanczakDominik merged 16 commits into
PlasmaPy:mainfrom
TrestanSimon:Add_Lundquist_number

Conversation

@TrestanSimon

@TrestanSimon TrestanSimon commented Jul 20, 2022 •

Copy link
Copy Markdown
Contributor

This PR adds a function to calculate the Lundquist number.

  • I have added a changelog entry for this pull request.
  • If adding new functionality, I have added tests and
    docstrings.
  • I have fixed any newly failing tests.

@github-actions github-actions Bot added docs PlasmaPy Docs at http://docs.plasmapy.org plasmapy.formulary Related to the plasmapy.formulary subpackage labels Jul 20, 2022

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Thank you for making your first contribution to PlasmaPy! The project's future depends on contributors like you, so we deeply appreciate it! 🌱
To make sure that you get credit for this pull request (PR), please add yourself to the list of contributors in docs/about/credits.rst.
We encourage you to check out our contributor guide, which discusses topics like adding changelog entries. If you'd like to talk with us in real time, the easiest way is via our chat room. We also invite you to stop by our weekly community meeting or office hours.
The bottom of this page includes several checks that are run for every PR. Don't worry if something broke! We break stuff all the time. Eventually we'll want to get checks on this PR to pass before merging it. Clicking on Details next to the check will show the results of the test, including error messages. Please feel free to ask for help if you're having trouble (we do that all the time, as well).
Our testing guide describes these checks in more detail, as well as how to write and run tests. We recommend trying out test-driven development: write tests first, and then write code to make tests pass. Remember to run tests often!
As described in our documentation guide, PlasmaPy's documentation is written in reStructuredText using the numpydoc docstring standard. To see a preview of the documentation from this PR, click on Details next to the docs/readthedocs.org:plasmapy check.
To automagically fix most linter problems, comment on this PR with pre-commit.ci autofix, followed by a git pullto bring the changes home to your own computer.
A code maintainer should come by soon to begin a code review. This step often includes suggestions for fixing bugs, adding tests, or simplifying the implementation. After that you'll have a chance to make changes. If you'd like more time before a code review happens, you can convert this PR to a draft now and mark it as ready for review later.
Finally, we try to be the best community we can be. We have a Code of Conduct to foster a community of care and appreciation.
We thank you once again! ✨

@TrestanSimon

Copy link
Copy Markdown
Contributor Author

pre-commit.ci autofix

@codecov

codecov Bot commented Jul 20, 2022 •

Copy link
Copy Markdown

Codecov Report

Merging #1642 (9e89e97) into main (d9e5132) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main    #1642   +/-   ##
=======================================
  Coverage   97.23%   97.23%           
=======================================
  Files          85       85           
  Lines        8020     8024    +4     
=======================================
+ Hits         7798     7802    +4     
  Misses        222      222           
Impacted Files Coverage Δ
plasmapy/formulary/parameters.py 100.00% <ø> (ø)
plasmapy/formulary/dimensionless.py 100.00% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Comment thread plasmapy/formulary/dimensionless.py Resolved
Comment thread plasmapy/formulary/dimensionless.py Resolved

@rocco8773 rocco8773 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Can you please add "Lundquist_number" (and "Lu_" if we're keeping it) tho this if-clause in plasmapy.formulary.parameters? This bit is a little weird, but we have to do it for now so plasmapy.formulary.parameters remains backwards compatible until version 0.9.0. This should also fix the documentation build error.

@StanczakDominik StanczakDominik left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The changes look pretty reasonable to me 👍🏻 I'll hold off for @rocco8773's opinion though.

@TrestanSimon
TrestanSimon requested a review from rocco8773 August 7, 2022 13:16
@TrestanSimon

TrestanSimon commented Aug 11, 2022 •

Copy link
Copy Markdown
Contributor Author

Can you please add "Lundquist_number" (and "Lu_" if we're keeping it) tho this if-clause in plasmapy.formulary.parameters? This bit is a little weird, but we have to do it for now so plasmapy.formulary.parameters remains backwards compatible until version 0.9.0. This should also fix the documentation build error.

Hi @rocco8773 . I have addressed this requested change (7fb2d8b). Can you dismiss/resolve it? I am unable to and merging is blocked until this requested change is "addressed" according to GitHub. Thanks.

@namurphy
namurphy self-requested a review August 11, 2022 19:25
@TrestanSimon

Copy link
Copy Markdown
Contributor Author

pre-commit.ci autofix

@StanczakDominik
StanczakDominik dismissed rocco8773’s stale review August 23, 2022 17:48

Changes got addressed!

@StanczakDominik StanczakDominik left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM, let's not hold it any longer :)

@StanczakDominik
StanczakDominik merged commit 6a6cc70 into PlasmaPy:main Aug 23, 2022
namurphy added a commit to namurphy/PlasmaPy that referenced this pull request Oct 25, 2022
@TrestanSimon
TrestanSimon deleted the Add_Lundquist_number branch June 9, 2023 17:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs PlasmaPy Docs at http://docs.plasmapy.org plasmapy.formulary Related to the plasmapy.formulary subpackage

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants