Skip to content

Make mostly stylistic edits to plasmapy.formulary.lengths#1982

Merged
StanczakDominik merged 5 commits into
PlasmaPy:mainfrom
namurphy:debye-length-docstring
Feb 24, 2023
Merged

Make mostly stylistic edits to plasmapy.formulary.lengths#1982
StanczakDominik merged 5 commits into
PlasmaPy:mainfrom
namurphy:debye-length-docstring

Conversation

@namurphy

Copy link
Copy Markdown
Member

This PR fixes a minor formatting issue in the docstring for plasmapy.formulary.lengths.Debye_length.

)
def Debye_length(T_e: u.K, n_e: u.m**-3) -> u.m:
r"""Calculate the characteristic decay length for electric fields,
due to charge screening.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

This extra space made the second line get formatted like a block quote.

@namurphy namurphy added no changelog entry needed For PRs that should not have a changelog entry docs PlasmaPy Docs at http://docs.plasmapy.org size: very small < 10 changed lines labels Feb 18, 2023
@namurphy namurphy marked this pull request as ready for review February 18, 2023 03:22
@namurphy namurphy requested a review from a team as a code owner February 18, 2023 03:22
@namurphy namurphy requested review from StanczakDominik and removed request for a team February 18, 2023 03:22
@codecov

codecov Bot commented Feb 18, 2023

Copy link
Copy Markdown

Codecov Report

Base: 98.32% // Head: 98.32% // No change to project coverage 👍

Coverage data is based on head (a599b4a) compared to base (fc12bbd).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1982   +/-   ##
=======================================
  Coverage   98.32%   98.32%           
=======================================
  Files          96       96           
  Lines        8500     8500           
=======================================
  Hits         8358     8358           
  Misses        142      142           
Impacted Files Coverage Δ
plasmapy/formulary/lengths.py 100.00% <ø> (ø)

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

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@namurphy namurphy changed the title Fix Debye length docstring Make mostly stylistic edits to plasmapy.formulary.lengths Feb 21, 2023
@namurphy namurphy added size: small 10 ≤ changed lines < 30 and removed size: very small < 10 changed lines labels Feb 21, 2023
@StanczakDominik StanczakDominik merged commit 8d55d43 into PlasmaPy:main Feb 24, 2023
@namurphy namurphy deleted the debye-length-docstring branch May 24, 2023 16:03
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 no changelog entry needed For PRs that should not have a changelog entry size: small 10 ≤ changed lines < 30

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants