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

update docs #2194

Merged
merged 1 commit into from
Aug 5, 2023
Merged

Conversation

GertjanBisschop
Copy link
Member

Update docs on additional_nodes flags and correct type in api.md.

@codecov
Copy link

codecov bot commented Aug 2, 2023

Codecov Report

Merging #2194 (33ac934) into main (25b1aee) will not change coverage.
The diff coverage is n/a.

❗ Current head 33ac934 differs from pull request most recent head 76b1ee1. Consider uploading reports for the commit 76b1ee1 to get more accurate results

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #2194   +/-   ##
=======================================
  Coverage   91.46%   91.46%           
=======================================
  Files          20       20           
  Lines       11254    11254           
  Branches     2297     2297           
=======================================
  Hits        10293    10293           
  Misses        523      523           
  Partials      438      438           
Flag Coverage Δ
C 91.46% <ø> (ø)
python 98.68% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed Coverage Δ
msprime/ancestry.py 98.66% <ø> (ø)

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 25b1aee...76b1ee1. Read the comment docs.

docs/ancestry.md Outdated Show resolved Hide resolved
docs/ancestry.md Outdated Show resolved Hide resolved
docs/ancestry.md Outdated Show resolved Hide resolved
docs/ancestry.md Outdated Show resolved Hide resolved
docs/ancestry.md Outdated Show resolved Hide resolved
@petrelharp
Copy link
Contributor

I made some suggestions to make it more precise; if you see a good way to have an even more precise (and pedantic?) definition of what exactly the node flags record somewhere, that could still be good.

@GertjanBisschop
Copy link
Member Author

Thanks a lot @petrelharp!

Co-authored-by: Peter Ralph <[email protected]>
Copy link
Member

@jeromekelleher jeromekelleher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, happy to merge whenever

@petrelharp
Copy link
Contributor

Thanks! Looks good.

@petrelharp petrelharp merged commit 1963a68 into tskit-dev:main Aug 5, 2023
13 checks passed
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

Successfully merging this pull request may close these issues.

3 participants