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

docs on missing data and coordinate systems, closes #1584 #1601

Merged
merged 2 commits into from
Dec 13, 2024

Conversation

petrelharp
Copy link
Contributor

In perusing #1584 I realized we hadn't written down this thing about the coordinate system being fixed even when we simulate a chunk. Now it's written down - hopefully without assuming the reader understands tskit too much?

Copy link

codecov bot commented Dec 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.84%. Comparing base (16497b3) to head (27221c7).
Report is 5 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1601      +/-   ##
==========================================
- Coverage   99.84%   99.84%   -0.01%     
==========================================
  Files         130      130              
  Lines        4410     4405       -5     
  Branches      607      606       -1     
==========================================
- Hits         4403     4398       -5     
  Misses          3        3              
  Partials        4        4              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@petrelharp
Copy link
Contributor Author

petrelharp commented Dec 13, 2024

Here's the result - maybe too verbose?

Screenshot from 2024-12-12 21-57-38
Screenshot from 2024-12-12 21-57-44

@gregorgorjanc
Copy link
Contributor

Looks good to me. I don’t find it too verbose - if docs are very terse then the reader already needs to know lots about tskit.

@petrelharp
Copy link
Contributor Author

Thanks! Well, I think these docs are aiming to get the reader to - say - VCFs as quickly and painlessly as possible. Hopefully people doing that will realize they don't need to worry about that. Hm: maybe I'll just add an explicit note saying so.

@petrelharp
Copy link
Contributor Author

Added
Screenshot from 2024-12-12 22-27-57

@petrelharp petrelharp merged commit 19245fc into popsim-consortium:main Dec 13, 2024
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants