tskit-dev / msprime

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

Clarify the population size is diploid (by default) #2212

Closed hyanwong closed 8 months ago

hyanwong commented 8 months ago

I think this is right. It is helpful to say "diploid population size" somewhere in the docs, as people might search for this phrase.

codecov[bot] commented 8 months ago

Codecov Report

Merging #2212 (db66482) into main (954321d) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #2212   +/-   ##
=======================================
  Coverage   91.52%   91.52%           
=======================================
  Files          20       20           
  Lines       11333    11333           
  Branches     2302     2302           
=======================================
  Hits        10372    10372           
  Misses        523      523           
  Partials      438      438           
Flag Coverage Δ
C 91.52% <ø> (ø)
python 98.70% <ø> (ø)

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


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 954321d...db66482. Read the comment docs.

petrelharp commented 8 months ago

I think this only failed because of

WARNING: The default value for `navigation_with_keys` will change to `False` in the next release. If you wish to preserve the old behavior for your site, set `navigation_with_keys=True` in the `html_theme_options` dict in your `conf.py` file.Be aware that `navigation_with_keys = True` has negative accessibility implications:https://github.com/pydata/pydata-sphinx-theme/issues/1492

Do you mind using this as an opportunity to check whether setting that value explicitly fixes things, @hyanwong? (Sounds like probably we want to set it explicitly to False but I haven't looked into it...)

benjeffery commented 8 months ago

I think this only failed because of

WARNING: The default value for `navigation_with_keys` will change to `False` in the next release. If you wish to preserve the old behavior for your site, set `navigation_with_keys=True` in the `html_theme_options` dict in your `conf.py` file.Be aware that `navigation_with_keys = True` has negative accessibility implications:https://github.com/pydata/pydata-sphinx-theme/issues/1492

Do you mind using this as an opportunity to check whether setting that value explicitly fixes things, @hyanwong? (Sounds like probably we want to set it explicitly to False but I haven't looked into it...)

Already fixed in #1395

hyanwong commented 8 months ago

Thanks Ben 🏅 ⭐