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.

Sign up for GitHub

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

Jump to bottom

Make arguments after population in TreeSequence.samples keyword only #1715

Closed
jeromekelleher opened this issue Sep 17, 2021 · 1 comment · Fixed by #1831
Closed

Make arguments after population in TreeSequence.samples keyword only #1715

jeromekelleher opened this issue Sep 17, 2021 · 1 comment · Fixed by #1831
Labels
Python API Issue is about the Python API
Milestone
Python 0.4.0

Comments

@jeromekelleher
Copy link
Member

We add a new time argument to ts.samples in #1692. We should make sure that this is used only as a keyword, especially with the deprecated population_id argument still lying around.

I suggest we change the signature to

def samples(self, population=None, *, population_id=None, time=None):
    ...
@jeromekelleher jeromekelleher added the Python API Issue is about the Python API label Sep 17, 2021
@jeromekelleher jeromekelleher added this to the Python 0.3.8 milestone Sep 17, 2021
@jeromekelleher
Copy link
Member Author

This is technically a breaking change, so good to get in for the 0.4.0 release.

@benjeffery benjeffery mentioned this issue Oct 21, 2021
Merged
@mergify mergify bot closed this as completed in #1831 Oct 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Python API Issue is about the Python API
Projects
None yet
Milestone
Python 0.4.0
Development

Successfully merging a pull request may close this issue.

Make TreeSequence.samples args kw only benjeffery/tskit
1 participant
@jeromekelleher