Documentation for LD matrix methods#3416
Open
apragsdale wants to merge 4 commits intotskit-dev:mainfrom
Open
Conversation
apragsdale
force-pushed
the
ld_matrix_docs
branch
from
271bcaa to
e2f50d6
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3416 +/- ##
==========================================
- Coverage 91.92% 91.33% -0.60%
==========================================
Files 37 37
Lines 32054 32054
Branches 5123 5123
==========================================
- Hits 29465 29275 -190
- Misses 2262 2451 +189
- Partials 327 328 +1
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
Member
jeromekelleher
left a comment
jeromekelleher
left a comment
There was a problem hiding this comment.
I've had a quick read through and generally looks great. I've spotted a few typos and left a few take-it-or-leave-it comments.
I haven't thought through the details at all through, and I think it needs a careful review from @petrelharp for that.
Author
|
Thanks so much for the quick review, @jeromekelleher. I agree with your suggestions and will fix things up accordingly. |
apragsdale
force-pushed
the
ld_matrix_docs
branch
from
e2f50d6 to
7e2b62a
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
See #3353.
This largely pulls material from an existing, open PR to complete minimal documentation for the LD matrix methods currently available in tskit. I've made edits for clarity from the original PR, and removed some material that is possibly confusing or more information than needed for a user.