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 RST Formatting for config_validator.rst #1553

Merged

Conversation

DhruvSondhi
Copy link
Contributor

Fixing general formatting issues with the config validator documentation

Description
Changes have been made to the rst formatting done in the config_validator documentation.
This makes the documentation easier to read & understand. :)

Motivation and context
As the documentation is quite old, changes to the formatting must also be done so as to bring it at par to current standards.
Simple fixes for the formatting have been done ... Furthermore, I will be opening PR for all the documentation formatting that can be done. :)

How has this been tested?

  • Testing pipeline.
  • Other.
    • Local Testing

Screenshot
image
image

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.

@codecov
Copy link

codecov bot commented Apr 26, 2021

Codecov Report

Merging #1553 (2bb485b) into master (c384d74) will decrease coverage by 1.28%.
The diff coverage is n/a.

❗ Current head 2bb485b differs from pull request most recent head 5dc73bd. Consider uploading reports for the commit 5dc73bd to get more accurate results
Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1553      +/-   ##
==========================================
- Coverage   68.24%   66.95%   -1.29%     
==========================================
  Files          73       73              
  Lines        6373     6034     -339     
==========================================
- Hits         4349     4040     -309     
+ Misses       2024     1994      -30     
Impacted Files Coverage Δ
...ntecarlo/montecarlo_numba/frame_transformations.py 35.00% <0.00%> (-13.00%) ⬇️
...s/tardis/montecarlo/montecarlo_numba/estimators.py 43.75% <0.00%> (-8.89%) ⬇️
...montecarlo/montecarlo_numba/calculate_distances.py 23.07% <0.00%> (-7.16%) ⬇️
.../tardis/montecarlo/montecarlo_numba/interaction.py 28.20% <0.00%> (-5.13%) ⬇️
.../montecarlo/montecarlo_numba/single_packet_loop.py 27.11% <0.00%> (-3.53%) ⬇️
...is/tardis/montecarlo/montecarlo_numba/opacities.py 80.00% <0.00%> (-3.34%) ⬇️
...dis/tardis/montecarlo/montecarlo_numba/r_packet.py 25.21% <0.00%> (-2.44%) ⬇️
...rdis/tardis/montecarlo/montecarlo_numba/vpacket.py 17.47% <0.00%> (-2.34%) ⬇️
tardis/tardis/plasma/properties/util/macro_atom.py 29.03% <0.00%> (-2.22%) ⬇️
...rdis/montecarlo/montecarlo_numba/tests/conftest.py 91.11% <0.00%> (-1.88%) ⬇️
... and 39 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 c384d74...5dc73bd. Read the comment docs.

Copy link
Member

@isaacgsmith isaacgsmith left a comment

Choose a reason for hiding this comment

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

It looks good!

@KevinCawley
Copy link
Contributor

Nice work

@andrewfullard andrewfullard merged commit 7e1a513 into tardis-sn:master May 14, 2021
@DhruvSondhi DhruvSondhi deleted the validator_docs_formatting branch May 16, 2021 14:42
@andrewfullard andrewfullard moved this from In progress to Done in Documentation Jun 9, 2021
atharva-2001 pushed a commit to atharva-2001/tardis that referenced this pull request Oct 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Documentation
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

4 participants