Julianus Pfeuffer
Julianus Pfeuffer
the keyword is `return` not `returns` https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html
Was this all tested anyhow? I think actually the bigger problem are the overloads. They will destroy those nice docstrings anyway.
Ok, so how does BayesianProteinInferenceAlgorithm inferPosteriorProbabilities look like in your docs?
Ah nice. What about the second overload? Does it pick up its parameters nicely as well?
Ok but the second item/signature should be less indented (i.e. to the left). We have to fix that in autowrap
But how would the user know which signature they are currently looking at? We need something to distinguish them.
And it might help (advanced) users to see when a parameter is const (i.e. if the object will change when passing it to the function).
Code snippets need to be escaped with `.. code-block: python` https://github.com/OpenMS/OpenMS/pull/6358/files#diff-2c24dd8b59090d3cd6ef007766de5c77e90e0b5f5e7df4ba2802ae5fcaae6436L37
I will merge since we need the fixes for successful rendering but please follow up on the comments in another PR. Thanks!
Hey @hendrikweisser I think you are correct with your analysis on when which value is used. However, I think it was more an unconscious decision (@timosachsenberg correct me if I...