Set/fix typehints in visualize/profiles.py / visualize/reference_poin…

[dweindl]

…ts.py

And remove redundant / contradictory types from docstrings

[codecov-commenter]

Codecov Report

Attention: 396 lines in your changes are missing coverage. Please review.

Comparison is base (160c2a8) 88.16% compared to head (2299b85) 84.11%.
Report is 451 commits behind head on develop.

Files	Patch %	Lines
pypesto/ensemble/ensemble.py	69.36%	68 Missing ⚠️
...ypesto/hierarchical/spline_approximation/solver.py	83.68%	47 Missing ⚠️
pypesto/ensemble/util.py	65.13%	38 Missing ⚠️
pypesto/hierarchical/optimal_scaling/solver.py	93.53%	26 Missing ⚠️
pypesto/history/base.py	88.57%	24 Missing ⚠️
pypesto/hierarchical/petab.py	84.56%	23 Missing ⚠️
pypesto/engine/mpi_pool.py	0.00%	22 Missing ⚠️
pypesto/hierarchical/inner_calculator_collector.py	89.04%	16 Missing ⚠️
...pesto/hierarchical/spline_approximation/problem.py	89.18%	16 Missing ⚠️
pypesto/hierarchical/optimal_scaling/calculator.py	75.86%	14 Missing ⚠️
... and 19 more

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #1223      +/-   ##
===========================================
- Coverage    88.16%   84.11%   -4.06%     
===========================================
  Files           79      148      +69     
  Lines         5257    11857    +6600     
===========================================
+ Hits          4635     9973    +5338     
- Misses         622     1884    +1262     

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

[Doresic]

Nice changes, thank you.
For my information, descriptions like profile_indices: list of integer values are not nice, so that's why you're removing and adding them to the function input like Sequence[int]?

[Doresic]

Should this be colors: Sequence[tuple] or something similar?

[dweindl]

"or something similar" 😅
I am not completely sure which types are supported.

[dweindl]

For my information, descriptions like profile_indices: list of integer values are not nice, so that's why you're removing and adding them to the function input like Sequence[int]?

They are not bad per se. However, proper type annotations can be used for static code analysis, those other comments cannot. And redundancy is bad. Also, as you can see in some of the changes, those comments don't reflect the actually expected types.