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

Small fixes to I/O documentation #1660

Merged
merged 4 commits into from Jul 1, 2021

Conversation

isaacgsmith
Copy link
Member

@isaacgsmith isaacgsmith commented Jun 18, 2021

This is a follow up to my pull requests restructuring the documentation which ties up some loose ends in the I/O documentation.

Description

Changes include:

  • Editing the atomic data configuration page to link Carsus
  • Adding a section that I forgot to add on the plasma configuration page
  • Creating virtual packet logging documentation
  • Added a callbacks page to the additional output section

How has this been tested?

  • Testing pipeline.
  • Documentation built locally and on GitHub.

Examples

View the built documentation here:
https://smithis7.github.io/tardis/branch/io-quick-fixes/

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.

@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 Jun 18, 2021

Codecov Report

Merging #1660 (0422f31) into master (eaab7a1) will not change coverage.
The diff coverage is n/a.

❗ Current head 0422f31 differs from pull request most recent head ee37e13. Consider uploading reports for the commit ee37e13 to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1660   +/-   ##
=======================================
  Coverage   61.89%   61.89%           
=======================================
  Files          62       62           
  Lines        5732     5732           
=======================================
  Hits         3548     3548           
  Misses       2184     2184           

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 eaab7a1...ee37e13. Read the comment docs.

@wkerzendorf
Copy link
Member

@smithis7 can you rebase?

@isaacgsmith
Copy link
Member Author

@smithis7 can you rebase?

I did a merge commit (I'm still working on getting good at rebasing) but I solved the conflict.

Copy link
Member

@jaladh-singhal jaladh-singhal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good - just have few additional suggestions that are related to this PR

docs/io/configuration/components/plasma.rst Outdated Show resolved Hide resolved
docs/io/output/vpacket_logging.rst Show resolved Hide resolved
docs/io/output/vpacket_logging.rst Show resolved Hide resolved
Copy link
Member

@jaladh-singhal jaladh-singhal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes!

@jaladh-singhal jaladh-singhal merged commit 2a61bad into tardis-sn:master Jul 1, 2021
@isaacgsmith isaacgsmith deleted the io-quick-fixes branch July 9, 2021 22:38
atharva-2001 pushed a commit to atharva-2001/tardis that referenced this pull request Oct 1, 2021
* adding missing info in config docs

* added callback and vpacket logging output docs [build docs]

* Jaladh's suggested changes

* Corrected typo
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

5 participants