Skip to content

Things to document in tree_t struct for 1.0 #2140

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom
Closed
jeromekelleher opened this issue Mar 2, 2022 · 1 comment
Closed

Things to document in tree_t struct for 1.0 #2140

jeromekelleher opened this issue Mar 2, 2022 · 1 comment
Assignees
@jeromekelleher
Labels
C API Issue is about the C API
Milestone
C API 1.0

Comments

@jeromekelleher
Copy link
Member

  • top level methods like tree_init, tree_free etc
  • All seek methods, first, last etc
  • get_index, get_num_roots
  • Node queries like is_descendent, is_sample,

Probably easier to list what not to document:

  • map_mutations
  • kc_distance
  • tsk_tree_track_descendant_samples
  • Stuff for tracked_samples

Everything else needs to be documented really.
@jeromekelleher jeromekelleher added the C API Issue is about the C API label Mar 2, 2022
@jeromekelleher jeromekelleher added this to the C API 1.0 milestone Mar 2, 2022
@jeromekelleher jeromekelleher self-assigned this Mar 2, 2022
This was referenced Apr 22, 2022
Merged
Closed
This was referenced Apr 28, 2022
Closed
Closed
@jeromekelleher
Copy link
Member Author

This is under control now, with #1886 being the last step.

# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees

@jeromekelleher jeromekelleher

Labels
C API Issue is about the C API
Projects
None yet
Milestone
C API 1.0
Development

No branches or pull requests
1 participant
@jeromekelleher