Add tables.load docstring#3453
Open
hyanwong wants to merge 1 commit intotskit-dev:mainfrom
Open
Conversation
hyanwong
force-pushed
the
doc-tables-load
branch
from
cb29631 to
5af5c97
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3453 +/- ##
=======================================
Coverage 91.66% 91.66%
=======================================
Files 38 38
Lines 32184 32184
Branches 5150 5150
=======================================
Hits 29503 29503
Misses 2348 2348
Partials 333 333
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
petrelharp
reviewed
Apr 29, 2026
| """ | ||
| Load a TableCollection from a file or path, saved in the format defined by | ||
| :meth:`.dump`. If the file is not in a valid format, an exception will be | ||
| raised. |
Contributor
There was a problem hiding this comment.
This doesn't do any validation, right? (e.g., doing tables.tree_sequence() might produce an error) This would be a useful thing to point out here, since that's one of the main uses for this function (loading up tables that don't validate).
Member
There was a problem hiding this comment.
Correct -- no validation happens. The relevant logic is line 4943 of _tskitmodule.c.
Member
Author
There was a problem hiding this comment.
Yeah, great point. I will add that comment
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
3 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.
Fixes #3406