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 docs #1716

Merged
merged 3 commits into from
Jul 15, 2021
Merged

Conversation

isaacgsmith
Copy link
Member

Small changes related to two of my recently-merged pull requests.

Description

Motivation and context

How has this been tested?

  • Testing pipeline.
  • Documentation built locally.

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.

1 similar comment
@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 Jul 13, 2021

Codecov Report

Merging #1716 (b5e46d5) into master (7d3899e) will increase coverage by 0.81%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1716      +/-   ##
==========================================
+ Coverage   61.06%   61.87%   +0.81%     
==========================================
  Files          63       63              
  Lines        5820     5852      +32     
==========================================
+ Hits         3554     3621      +67     
+ Misses       2266     2231      -35     
Impacted Files Coverage Δ
tardis/tardis/io/atom_data/base.py 89.77% <0.00%> (-1.51%) ⬇️
tardis/tardis/util/base.py 74.35% <0.00%> (-1.44%) ⬇️
tardis/tardis/base.py 57.69% <0.00%> (-1.40%) ⬇️
...s/tardis/plasma/properties/radiative_properties.py 77.18% <0.00%> (-0.53%) ⬇️
tardis/tardis/io/util.py 71.67% <0.00%> (-0.52%) ⬇️
tardis/tardis/simulation/base.py 82.88% <0.00%> (-0.45%) ⬇️
tardis/tardis/plasma/properties/nlte.py 38.83% <0.00%> (-0.39%) ⬇️
tardis/tardis/montecarlo/base.py 88.77% <0.00%> (ø)
tardis/tardis/montecarlo/spectrum.py 65.51% <0.00%> (ø)
tardis/tardis/util/colored_logger.py
... and 7 more

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 7d3899e...b5e46d5. Read the comment docs.

@isaacgsmith isaacgsmith removed the request for review from DhruvSondhi July 14, 2021 14:45
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 perfect!

@jaladh-singhal jaladh-singhal merged commit de2d7be into tardis-sn:master Jul 15, 2021
@isaacgsmith isaacgsmith deleted the small_fixes_doc branch July 15, 2021 18:27
DhruvSondhi pushed a commit to DhruvSondhi/tardis that referenced this pull request Aug 1, 2021
* correcting and reformatting vpacket logging docs

* fixing bad docstring

* following docstring rules
atharva-2001 pushed a commit to atharva-2001/tardis that referenced this pull request Oct 1, 2021
* correcting and reformatting vpacket logging docs

* fixing bad docstring

* following docstring rules
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.

4 participants