Visitar URL original
Add a troubleshooting section to documentation guide by namurphy · Pull Request #1752 · PlasmaPy/PlasmaPy · GitHub
Skip to content

Add a troubleshooting section to documentation guide - #1752

Merged
namurphy merged 3 commits into
PlasmaPy:mainfrom
namurphy:doc-guide-troubleshooting
Oct 5, 2022
Merged

namurphy merged 3 commits into
PlasmaPy:mainfrom
namurphy:doc-guide-troubleshooting

Conversation

@namurphy

@namurphy namurphy commented Oct 4, 2022

Copy link
Copy Markdown
Member

This PR begins a troubleshooting section for when building documentation. It starts out with a discussion on what to do when encountering a warning for "reference not found", including in type lines.

@github-actions

github-actions Bot commented Oct 4, 2022

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 Oct 5, 2022 •

Copy link
Copy Markdown

Codecov Report

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

Coverage data is based on head (d39d173) compared to base (5ccffbe).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1752   +/-   ##
=======================================
  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.

@namurphy namurphy changed the title Add a troubleshooting section to documenation guide Add a troubleshooting section to documentation guide Oct 5, 2022
@namurphy
namurphy marked this pull request as ready for review October 5, 2022 14:38
@namurphy
namurphy requested a review from a team as a code owner October 5, 2022 14:38
@namurphy
namurphy merged commit 4e3d52b into PlasmaPy:main Oct 5, 2022
@namurphy
namurphy deleted the doc-guide-troubleshooting branch October 5, 2022 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants