Thanks for your answer!
Since I have 3 distinct methods for my recipe that dispatch on the parameter of the SimResult
instance (the code is bit simplified for my explanation):
@recipe plot_recipe(res::SimResult{<:SimModel}; arg1=true, ...) = ...
@recipe plot_recipe(res::SimResult{<:StateEstimator}; arg2=true, ...) = ...
@recipe plot_recipe(res::SimResult{<:PredictiveController}; arg3=true, ...) = ...
it’s not clear how I can apply your suggestion.
I ended up creating 3 additional dummy methods for the sole purpose of documenting my plot recipes:
"My docstring 1"
plot_recipe(::Nothing, ::SimResult{<:SimModel}) = nothing
"My docstring 2"
plot_recipe(::Nothing, ::SimResult{<:StateEstimator}) = nothing
"My docstring 3"
plot_recipe(::Nothing, ::SimResult{<:PredictiveController}) = nothing
It’s not the cleanest solution since it’s hard to find in the ?
-mode, but it works well in the online documentation.