-
-
Notifications
You must be signed in to change notification settings - Fork 405
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
correct the description of 'no_of_packets' in TARDIS Documentation #2086
Conversation
*beep* *bop* Hi, human. The Click here to see your results. |
tardis/io/schemas/montecarlo.yml
Outdated
@@ -17,7 +17,7 @@ properties: | |||
no_of_packets: | |||
type: number | |||
multipleOf: 1.0 | |||
description: Seed for the random number generator | |||
description: This gives the number of packets normally used in each iteration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't fully agree with the word "normally" here. I would specify that it is used for all but the final iteration.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@smithis7
Thanks for reviewing!
Will look into it for corrections...
Codecov Report
@@ Coverage Diff @@
## master #2086 +/- ##
=======================================
Coverage 58.30% 58.30%
=======================================
Files 75 75
Lines 8685 8685
=======================================
Hits 5064 5064
Misses 3621 3621 📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more |
@smithis7 |
@andrewfullard is this a good description? If you think so I'll approve. |
📝 Description
Type: : 📝
Description of no_of_particles parameter was incorrect in TARDIS documentation[ https://tinyurl.com/ef64s538 ]. So I looked up and corrected the description.
closes #2066 (comment)
📌 Resources
https://tinyurl.com/ef64s538
🚦 Testing
How did you test these changes?
☑️ Checklist
build_docs
label