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

Fixing broken documentation #1811

Merged

Conversation

isaacgsmith
Copy link
Member

@isaacgsmith isaacgsmith commented Oct 14, 2021

Description

  • Has documentation reflect change from export_cplot to export_convergence_plot
  • Comments out some plots in the SDEC notebook. THIS IS A TEMPORARY FIX!!!! The current page is too large which breaks the documentation build. We need to figure out a way to fix this, but this PR will just make it so the documentation will build while we figure out what to do with the SDEC notebook.

How has this been tested?

Type of change

  • Bug fix.
  • New feature.
  • Breaking change.
  • None of the above.

Checklist

  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.
    • (optional) I have built the documentation on my fork following the instructions.
  • I have assigned and requested two reviewers for this pull request.

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@isaacgsmith isaacgsmith changed the title ixing broken documentation Fixing broken documentation Oct 14, 2021
@tardis-bot
Copy link
Contributor

Before a pull request is accepted, it must meet the following criteria:

  • Is the necessary information provided?
  • Is this a duplicate PR?
    • If a new PR is clearly a duplicate, ask how this PR is different from the original PR?
    • If this PR is about to be merged, close the original PR with a link to this new PR that solved the issue.
  • Does it pass existing tests and are new tests provided if required?
    • The test coverage should not decrease, and for new features should be close to 100%.
  • Is the code tidy?
    • No unnecessary print lines or code comments.

@codecov
Copy link

codecov bot commented Oct 14, 2021

Codecov Report

Merging #1811 (b3f5d1f) into master (a3fbc50) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1811   +/-   ##
=======================================
  Coverage   58.25%   58.25%           
=======================================
  Files          66       66           
  Lines        6721     6721           
=======================================
  Hits         3915     3915           
  Misses       2806     2806           

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 a3fbc50...b3f5d1f. Read the comment docs.

@atharva-2001 atharva-2001 self-requested a review October 14, 2021 15:29
@andrewfullard andrewfullard merged commit efebacd into tardis-sn:master Oct 14, 2021
@isaacgsmith isaacgsmith mentioned this pull request Oct 20, 2021
8 tasks
@isaacgsmith isaacgsmith deleted the fixing_visualization_doc branch October 26, 2021 21:20
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.

None yet

4 participants