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

Better Docs for individual_/genome_ operators #199

Open
2 tasks
escott-mitre opened this issue May 13, 2022 · 0 comments
Open
2 tasks

Better Docs for individual_/genome_ operators #199

escott-mitre opened this issue May 13, 2022 · 0 comments

Comments

@escott-mitre
Copy link
Contributor

We have an unfortunate and confusing pattern of having operators (which apply to iterators) named my_operator and helpers that they are build from (which apply to a single genome or individual) named things like individaul_my_operator or genome_my_operator.

This affects users particular when they want to work with segmented genomes, since the segmented.ops.apply_mutation() expects one of these strange little helpers to be passed in (and not a regular operator).

  • At a minimum, improve the docs on these functions to explain the difference better.
  • Better yet, find a way to refactor things so this confusing distinction is no longer necessary (or is made obvious by better names)
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