Visitar URL original
Revise changelog entries for 0.9.0 release by namurphy · Pull Request #1768 · PlasmaPy/PlasmaPy · GitHub
Skip to content

Revise changelog entries for 0.9.0 release - #1768

Merged
namurphy merged 37 commits into
PlasmaPy:mainfrom
namurphy:update-changelogs-0.9.0
Oct 26, 2022
Merged

namurphy merged 37 commits into
PlasmaPy:mainfrom
namurphy:update-changelogs-0.9.0

Conversation

@namurphy

Copy link
Copy Markdown
Member

This PR goes through the changelog files since the 0.8.1 release to make the style more consistent. I added some links and updated reST formatting here and there, and also split up a few of the entries into multiple files.

@namurphy namurphy added this to the 0.9.0 milestone Oct 25, 2022
@github-actions

Copy link
Copy Markdown

Thank you for contributing to PlasmaPy! The project's future depends deeply on contributors like you, so we deeply appreciate it! 🌱 The following checklist will be used by the code reviewer to help guide the code review process.

  • Overall
    • Does the PR do what it intends to do?
    • Except for very minor changes, is a changelog entry included and consistent with the changelog guide?
    • Are the continuous integration checks passing? (Most linter problems can be automagically fixed by commenting on this PR with pre-commit.ci autofix.)
  • Code
    • Is new/updated code understandable and consistent with the coding guide?
    • Are there ways to greatly simplify the implementation?
    • Are there any large functions that should be split up into shorter functions?
  • Tests
    • Are tests added/updated as required, and consistent with the testing guide?
    • Are the tests understandable?
    • Do the tests cover all important cases?
  • Docs
    • Are docs added/updated as required, and consistent with the doc guide?
    • Are the docs understandable?
    • Do the docs show up correctly in the preview, including Jupyter notebooks?

@namurphy namurphy removed the Breaking label Oct 25, 2022
@namurphy namurphy added the no changelog entry needed For PRs that should not have a changelog entry label Oct 25, 2022
@codecov

codecov Bot commented Oct 25, 2022 •

Copy link
Copy Markdown

Codecov Report

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

Coverage data is based on head (fa08655) compared to base (4e14614).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1768   +/-   ##
=======================================
  Coverage   98.36%   98.36%           
=======================================
  Files          86       86           
  Lines        8176     8176           
=======================================
  Hits         8042     8042           
  Misses        134      134           

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.

The deprecation notice initially said that the new functionality was
the CollisionFrequencies class, which was broken up into multiple
distribution-function-specific classes in PlasmaPy#1703.
The detail on the ``inplace`` keyword seemed different from the
docstring description, so I dropped the description from the changelog
entry.
The line spacing was weird in the changelog, so I'm starting the lines not with reST links.
Changing this again since it is still showing up formatted weird.
Trying to fix resulting weird formatting.
@namurphy
namurphy marked this pull request as ready for review October 26, 2022 14:07
@namurphy
namurphy requested a review from a team as a code owner October 26, 2022 14:07
@namurphy
namurphy requested review from StanczakDominik and removed request for a team October 26, 2022 14:07

@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.

I skimmed these and found no glaring weirdness 👍🏻

@namurphy
namurphy merged commit 2ad694d into PlasmaPy:main Oct 26, 2022
@namurphy
namurphy deleted the update-changelogs-0.9.0 branch October 26, 2022 16:14
@namurphy namurphy added release Related to releasing a new version of PlasmaPy and removed status: in progress labels May 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no changelog entry needed For PRs that should not have a changelog entry release Related to releasing a new version of PlasmaPy

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants