tskit-dev / msprime

Simulate genealogical trees and genomic sequence data using population genetic models
GNU General Public License v3.0
173 stars 85 forks source link

update docs #2194

Closed GertjanBisschop closed 1 year ago

GertjanBisschop commented 1 year ago

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

codecov[bot] commented 1 year ago

Codecov Report

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

:exclamation: 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.

petrelharp commented 1 year ago

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 commented 1 year ago

Thanks a lot @petrelharp!

petrelharp commented 1 year ago

Thanks! Looks good.