doc: petab.v2.core

[dweindl]

👀 https://petab--360.org.readthedocs.build/projects/libpetab-python/en/360/build/_autosummary/petab.v2.core.html

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.44%. Comparing base (0643389) to head (5502460).

Additional details and impacted files

@@           Coverage Diff            @@
##           develop     #360   +/-   ##
========================================
  Coverage    74.44%   74.44%           
========================================
  Files           57       57           
  Lines         5987     5987           
  Branches      1039     1039           
========================================
  Hits          4457     4457           
  Misses        1133     1133           
  Partials       397      397           

☔ 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.

[dilpath]

Looks good 👍

The "module attributes" (ObjectivePriorType, InitializationPriorType) are listed on RTD but not doc'd -- is this because they might be refactored? Fine for me.

[dilpath]

Using "10" is fine but it looks like int/float is handled? Is this to stress that the type is an expression? Then maybe using e.g. k1+3 makes the point better.

[dweindl]

That's to test that strings are accepted/converted.

[dweindl]

The "module attributes" (ObjectivePriorType, InitializationPriorType) are listed on RTD but not doc'd -- is this because they might be refactored? Fine for me.

That's because they are just aliases. Either we have separate types, or we only have the members of the original type documented. And yes, I wouldn't bother until it's decided whether/how they will change.