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

Fix references and typos in documentation #2224

Merged
merged 6 commits into from
Aug 18, 2023

Conversation

shreyas3156
Copy link
Member

@shreyas3156 shreyas3156 commented Feb 27, 2023

📝 Description

Type: 📝 documentation

  • Fixes a typo in the Physics Walkthrough Intro doc.
  • Changed the velocity subscript in the 'Model' notebook.
  • Fixes a few grammatical errors.
  • Corrects the reference to Energy Packet Initialization doc in Line Interaction Treatments (which was earlier referring to some Python package).

📌 Resources

Examples, notebooks, and links to useful references.

🚦 Testing

How did you test these changes?

  • Testing pipeline
  • Other method (describe)
  • My changes can't be tested (explain why)

☑️ Checklist

  • I requested two reviewers for this pull request
  • I updated the documentation according to my changes
  • I built the documentation by applying the build_docs label

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@tardis-bot
Copy link
Contributor

*beep* *bop*

Hi, human.

I'm the @tardis-bot and couldn't find your records in my database. I think we don't know each other, or you changed your credentials recently.

Please add your name and email to .mailmap in your current branch and push the changes to this pull request.

In case you need to map an existing alias, follow this example.

@andrewfullard
Copy link
Contributor

Nice PR, though the gamma-ray documentation notebook is pre-run because it currently cannot be run as part of the documentation action workflow

@shreyas3156
Copy link
Member Author

Nice PR, though the gamma-ray documentation notebook is pre-run because it currently cannot be run as part of the documentation action workflow

Thanks for the review. Shall I remove the commit with the change in the gamma-ray notebook?

@codecov
Copy link

codecov bot commented Mar 14, 2023

Codecov Report

Merging #2224 (016d6a4) into master (24338e3) will increase coverage by 0.00%.
The diff coverage is 100.00%.

❗ Current head 016d6a4 differs from pull request most recent head 56aaebf. Consider uploading reports for the commit 56aaebf to get more accurate results

@@           Coverage Diff           @@
##           master    #2224   +/-   ##
=======================================
  Coverage   71.81%   71.82%           
=======================================
  Files         133      133           
  Lines       12355    12358    +3     
=======================================
+ Hits         8873     8876    +3     
  Misses       3482     3482           
Impacted Files Coverage Δ
tardis/analysis.py 32.40% <ø> (ø)
tardis/base.py 75.00% <ø> (ø)
tardis/montecarlo/montecarlo_numba/base.py 32.50% <100.00%> (+0.56%) ⬆️
tardis/util/base.py 74.20% <100.00%> (+0.20%) ⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@shreyas3156 shreyas3156 force-pushed the docs-path-typo-fixes branch from e4e8665 to e4c1621 Compare March 27, 2023 14:08
@shreyas3156 shreyas3156 force-pushed the docs-path-typo-fixes branch from e4c1621 to 98a54f8 Compare March 27, 2023 14:15
@shreyas3156 shreyas3156 changed the title Fix path location and typos in documentation Fix references and typos in documentation Mar 27, 2023
@shreyas3156
Copy link
Member Author

@andrewfullard @smithis7 I have removed the commit with the path-correction in gamma-ray notebook and added a few other commits.

@isaacgsmith
Copy link
Member

The docs don't seem to be building on GitHub, I'm not sure why. I want to take a look at the built docs before approving, but it looks very good.

@shreyas3156
Copy link
Member Author

The docs don't seem to be building on GitHub, I'm not sure why. I want to take a look at the built docs before approving, but it looks very good.

Sure! We can try it out once the build-docs issue is fixed.

@andrewfullard andrewfullard merged commit a2bee92 into tardis-sn:master Aug 18, 2023
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.

5 participants