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

Docstring for VariantData needs writing #955

Closed
hyanwong opened this issue Aug 28, 2024 · 1 comment
Closed

Docstring for VariantData needs writing #955

hyanwong opened this issue Aug 28, 2024 · 1 comment
Milestone

Comments

@hyanwong
Copy link
Member

At the moment if you do help(tsinfer.VariantData), you get the correct Initi signature described, but the rest of the docstring is wrong (is uses the one for SampleData):

Init signature:
tsinfer.VariantData(
    path,
    ancestral_allele,
    *,
    sample_mask=None,
    site_mask=None,
    sites_time=None,
)
Docstring:     
SampleData(sequence_length=0, *, path=None, num_flush_threads=0,     compressor=DEFAULT_COMPRESSOR, chunk_size=1024, max_file_size=None)

Class representing input sample data used for inference.
See sample data file format :ref:`specifications <sec_file_formats_samples>`
for details on the structure of this file.
@hyanwong hyanwong added this to the Release 0.4.0 milestone Aug 30, 2024
hyanwong added a commit to hyanwong/tsinfer that referenced this issue Sep 5, 2024
This describes using `N` to mean "unknown ancestral allele". Fixes tskit-dev#955
hyanwong added a commit to hyanwong/tsinfer that referenced this issue Sep 5, 2024
This describes using `N` to mean "unknown ancestral allele". Fixes tskit-dev#955
hyanwong added a commit to hyanwong/tsinfer that referenced this issue Sep 5, 2024
This describes using `N` to mean "unknown ancestral allele". Fixes tskit-dev#955
hyanwong added a commit to hyanwong/tsinfer that referenced this issue Sep 5, 2024
This describes using `N` to mean "unknown ancestral allele". Fixes tskit-dev#955
hyanwong added a commit to hyanwong/tsinfer that referenced this issue Sep 5, 2024
This describes using `N` to mean "unknown ancestral allele". Fixes tskit-dev#955
hyanwong added a commit to hyanwong/tsinfer that referenced this issue Sep 5, 2024
This describes using `N` to mean "unknown ancestral allele". Fixes tskit-dev#955
@hyanwong
Copy link
Member Author

Fixed in #963

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

No branches or pull requests

1 participant