specify units for recombination rate; closes #2375

[petrelharp]

I'm not clear this improves things, since what exactly the units are depends? (like, probably "per generation per bp" but only if that's what time and sequence length are measured in)

Hm, I should have done this on my branch (I did this just by clicking "edit"; probably we should disable that, since the default resulting option was "commit this directly to main".)

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.85%. Comparing base (8d65577) to head (435f93e).
⚠️ Report is 39 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2376   +/-   ##
=======================================
  Coverage   90.85%   90.85%           
=======================================
  Files          20       20           
  Lines       11993    11993           
  Branches     2330     2330           
=======================================
  Hits        10896    10896           
  Misses        606      606           
  Partials      491      491           

Flag	Coverage Δ
C	90.85% <ø> (ø)
python	98.68% <ø> (ø)

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[jeromekelleher]

I'm not sure this makes this clearer either - maybe what we should do is add a note about "Units" to the documentation here and add a link to this section to the parameter docstring?

[timothymillar]

Thanks @petrelharp and @jeromekelleher. I think a note in the ancestry docs would do it. I found the ancestry docs very quickly when looking for more info.

[jeromekelleher]

Closed in favour of #2391