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

Put example notebooks in sub-directories, run nb-clean, and make minor edits #1590

Merged
merged 41 commits into from
Jul 2, 2022

Conversation

namurphy
Copy link
Member

  • I moved the notebooks in docs/notebooks to the appropriate subdirectories. Most were associated with plasmapy.formulary.
  • I ran nb-clean on all of the notebooks that were not pre-executed. This removes some unnecessary metadata.
  • I renamed physics.ipynb to iter.ipynb, since that reflected the obsolete plasmapy.physics subpackage which was renamed to plasmapy.formulary.
  • I made a few minor edits to some notebooks, mostly for links & formatting.

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@github-actions github-actions bot added the notebooks Related to example Jupyter notebooks in docs/examples/ label Jun 24, 2022
...since this package is deprecated.
@codecov
Copy link

codecov bot commented Jun 24, 2022

Codecov Report

Merging #1590 (5c1c2eb) into main (d2ab647) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1590   +/-   ##
=======================================
  Coverage   97.21%   97.21%           
=======================================
  Files          83       83           
  Lines        7961     7961           
=======================================
  Hits         7739     7739           
  Misses        222      222           
Impacted Files Coverage Δ
plasmapy/analysis/nullpoint.py 98.53% <0.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d2ab647...5c1c2eb. Read the comment docs.

@rocco8773 rocco8773 added this to the 0.9.0 milestone Jun 28, 2022
@namurphy namurphy added the status: ready for review PRs that are ready for code review label Jul 1, 2022
@namurphy namurphy requested a review from rocco8773 July 1, 2022 22:07
@namurphy namurphy mentioned this pull request Jul 1, 2022
34 tasks
Co-authored-by: Erik Everson <[email protected]>
@namurphy namurphy merged commit 782c49f into PlasmaPy:main Jul 2, 2022
@namurphy namurphy deleted the notebook-reorganization branch July 2, 2022 00:01
@namurphy namurphy removed the status: ready for review PRs that are ready for code review label Aug 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
notebooks Related to example Jupyter notebooks in docs/examples/
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants