Visitar URL original
Add a documentation page on performance tips by namurphy · Pull Request #1887 · PlasmaPy/PlasmaPy · GitHub
Skip to content

Add a documentation page on performance tips - #1887

Merged
StanczakDominik merged 6 commits into
PlasmaPy:mainfrom
namurphy:performance-tips
Jan 13, 2023
Merged

Add a documentation page on performance tips#1887
StanczakDominik merged 6 commits into
PlasmaPy:mainfrom
namurphy:performance-tips

Conversation

@namurphy

@namurphy namurphy commented Jan 12, 2023

Copy link
Copy Markdown
Member

This PR adds a page including performance tips to the online documentation. This is meant to be an initial version that can be updated later, when necessary.

Closes #1760.

@github-actions

github-actions Bot commented Jan 12, 2023

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?

@codecov

codecov Bot commented Jan 13, 2023 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

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

Coverage data is based on head (759d495) compared to base (6046d00).
Patch has no changes to coverable lines.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #1887   +/-   ##
=======================================
  Coverage   98.31%   98.31%           
=======================================
  Files          95       95           
  Lines        8404     8404           
=======================================
  Hits         8262     8262           
  Misses        142      142

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 marked this pull request as ready for review January 13, 2023 01:33
@namurphy
namurphy requested a review from a team as a code owner January 13, 2023 01:33
@namurphy
namurphy requested review from StanczakDominik and removed request for a team January 13, 2023 01:33
@namurphy

namurphy commented Jan 13, 2023

Copy link
Copy Markdown
Member Author

The documentation failure looks to be unrelated. It appears to be a problem with downloading packages from an Ubuntu archive. 🖥️

@StanczakDominik

StanczakDominik commented Jan 13, 2023

Copy link
Copy Markdown
Member

Yeah, there's no way that's related. Let's get it in :)

@StanczakDominik
StanczakDominik enabled auto-merge (squash) January 13, 2023 15:15
@StanczakDominik

StanczakDominik commented Jan 13, 2023 •
edited
Loading

Copy link
Copy Markdown
Member

Right, that job's marked as required. Suppose we waited a couple days for this server issue to resolve itself?

@StanczakDominik
StanczakDominik merged commit 878be59 into PlasmaPy:main Jan 13, 2023
@namurphy
namurphy deleted the performance-tips branch January 13, 2023 15:36
@namurphy namurphy mentioned this pull request Jan 13, 2023
Open
3 tasks
@namurphy namurphy added the docs PlasmaPy Docs at http://docs.plasmapy.org label May 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@StanczakDominik StanczakDominik StanczakDominik approved these changes

Assignees

No one assigned

Labels

docs PlasmaPy Docs at http://docs.plasmapy.org

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add a page on performance tips to the documentation

2 participants

@namurphy @StanczakDominik