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

added documentation for using particular refdata files for unit testing #2142

Merged
merged 1 commit into from
Aug 18, 2023

Conversation

jayantbhakar
Copy link
Member

📝 Description

Type: 📝 documentation

This PR adds documentation to the developer workflow when working with unit tests. It says how to download only a required slice of refdata for running some unit tests of interest .

Also, link issues affected by this pull request by using the keywords: close, closes, closed, fix, fixes, fixed, resolve, resolves or resolved.

📌 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

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

@tardis-bot
Copy link
Contributor

*beep* *bop*

Hi, human.

The docs workflow has failed

Click here to see the build log.

@codecov
Copy link

codecov bot commented Oct 30, 2022

Codecov Report

Merging #2142 (7bab82a) into master (e3184f4) will decrease coverage by 0.03%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #2142      +/-   ##
==========================================
- Coverage   61.63%   61.60%   -0.04%     
==========================================
  Files          75       76       +1     
  Lines        8649     8681      +32     
==========================================
+ Hits         5331     5348      +17     
- Misses       3318     3333      +15     
Impacted Files Coverage Δ
tardis/plasma/standard_plasmas.py 70.09% <0.00%> (-4.40%) ⬇️
tardis/plasma/properties/plasma_input.py 100.00% <0.00%> (ø)
tardis/plasma/properties/property_collections.py 100.00% <0.00%> (ø)
tardis/plasma/properties/rate_matrix_index.py 40.00% <0.00%> (ø)
tardis/io/util.py 80.50% <0.00%> (+2.51%) ⬆️

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

@andrewfullard andrewfullard enabled auto-merge (squash) October 31, 2022 15:36
@andrewfullard andrewfullard disabled auto-merge August 18, 2023 13:46
@andrewfullard andrewfullard merged commit ca587ff 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.

3 participants