Doc: Show typehints in description #1192
Conversation
Instead of in the signature. Much more readable.
Codecov ReportAttention:
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## develop #1192 +/- ##
===========================================
+ Coverage 84.24% 84.25% +0.01%
===========================================
Files 148 148
Lines 11724 11727 +3
===========================================
+ Hits 9877 9881 +4
+ Misses 1847 1846 -1 ☔ View full report in Codecov by Sentry. |
| ############################################################################### | ||
| # SELECT | ||
|
|
||
| TYPE_POSTPROCESSOR = Callable[["ModelProblem"], None] # noqa: F821 |
There was a problem hiding this comment.
@dilpath : Had to shuffle some things around to break circular dependencies. Is that okay?
| ############################################################################### | ||
| # SELECT | ||
|
|
||
| TYPE_POSTPROCESSOR = Callable[["ModelProblem"], None] # noqa: F821 |
| @@ -28,7 +28,7 @@ class PredictorTask(Task): | |||
|
|
|||
| def __init__( | |||
| self, | |||
| predictor: 'pypesto.predict.Predictor', # noqa: F821 | |||
| predictor, #: 'pypesto.predict.Predictor', # noqa: F821 | |||
There was a problem hiding this comment.
is this also commented due to circular imports?
There was a problem hiding this comment.
No, because it doesn't exist 😑 . This whole module is not used anywhere. I think it could/should be removed, but I went for the more conservative approach.
There was a problem hiding this comment.
Ah, it should be pypesto.predict.AmiciPredictor I guess -- there is no parent Predictor class.
There was a problem hiding this comment.
Possible, but not sure what was intended there, as it's really not used anywhere.
There was a problem hiding this comment.
Was introduced in this monster, without usage #490
Instead of in the signature. Much more readable.
E.g., before: https://pypesto.readthedocs.io/en/latest/api/pypesto.visualize.html#pypesto.visualize.waterfall
after: https://pypesto--1192.org.readthedocs.build/en/1192/api/pypesto.visualize.html#pypesto.visualize.waterfall
Also fixes some function documentation missing from sphinx docs due to lack of
wraps.Also removes some circular dependencies.