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

correct the description of 'no_of_packets' in TARDIS Documentation #2086

Closed
wants to merge 3 commits into from

Conversation

grgkaran03
Copy link

@grgkaran03 grgkaran03 commented Jul 10, 2022

📝 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?

  • Testing pipeline
  • Other method (describe)
  • My changes can't be tested ( Just corrected the text in .yml file. Don't think it needs tests.)

☑️ 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

Note: If you are not allowed to perform any of these actions, ping (@) a contributor.

@tardis-bot
Copy link
Contributor

tardis-bot commented Jul 10, 2022

*beep* *bop*

Hi, human.

The docs workflow has succeeded ✔️

Click here to see your results.

@@ -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.
Copy link
Member

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.

Copy link
Author

@grgkaran03 grgkaran03 Jul 20, 2022

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
Copy link

codecov bot commented Jul 20, 2022

Codecov Report

Merging #2086 (3c1d40f) into master (ec64bde) will not change coverage.
The diff coverage is n/a.

❗ Current head 3c1d40f differs from pull request most recent head dbfeecc. Consider uploading reports for the commit dbfeecc to get more accurate results

@@           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

@grgkaran03
Copy link
Author

@smithis7
please review the corrections...

@isaacgsmith
Copy link
Member

@andrewfullard is this a good description? If you think so I'll approve.

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.

Configuration parameter description for no_of_packets in the Documentation needs correction
4 participants