Skip to content

Update tree traversal C documentation #1886

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 Nov 4, 2021 · 2 comments
Closed

Update tree traversal C documentation #1886

jeromekelleher opened this issue Nov 4, 2021 · 2 comments
Assignees
@jeromekelleher
Labels
C API Issue is about the C API documentation Documentation
Milestone
C API 1.0

Comments

@jeromekelleher
Copy link
Member

#1862 updates the C code for tree traversals but not the documentation. We should revisit this.

A different structure might be appropriate now also, given we have jupyterbook.
@jeromekelleher jeromekelleher added C API Issue is about the C API documentation Documentation labels Nov 4, 2021
@jeromekelleher jeromekelleher added this to the C API 1.0.0 milestone Nov 4, 2021
@jeromekelleher jeromekelleher mentioned this issue Nov 4, 2021
Merged
@jeromekelleher
Copy link
Member Author

Probably worth doing this at the same time as #1788

@jeromekelleher
Copy link
Member Author

Can close this when we have API docs for the traversal methods, and have reviewed the C level traversal docs.

@jeromekelleher jeromekelleher self-assigned this May 4, 2022
@jeromekelleher jeromekelleher mentioned this issue May 4, 2022
Closed
jeromekelleher added a commit to jeromekelleher/tskit that referenced this issue May 5, 2022
@jeromekelleher
Document tree traversals in C
568b5af 
Add tsk_tree_preorder to do the default full traversal and rename
existing function to tsk_tree_preorder_from.

Update traversal docs

Closes tskit-dev#1886
jeromekelleher added a commit to jeromekelleher/tskit that referenced this issue May 9, 2022
@jeromekelleher
Document tree traversals in C
c880a13 
Add tsk_tree_preorder to do the default full traversal and rename
existing function to tsk_tree_preorder_from.

Update traversal docs

Closes tskit-dev#1886
jeromekelleher added a commit to jeromekelleher/tskit that referenced this issue May 9, 2022
@jeromekelleher
Document tree traversals in C
3bfcd88 
Add tsk_tree_preorder to do the default full traversal and rename
existing function to tsk_tree_preorder_from.

Update traversal docs

Closes tskit-dev#1886
@mergify mergify bot closed this as completed in 3b55fe5 May 9, 2022
# 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 documentation Documentation
Projects
None yet
Milestone
C API 1.0
Development

No branches or pull requests
1 participant
@jeromekelleher