From 39ccd7df10d53ad842f68547804d508432ae6678 Mon Sep 17 00:00:00 2001 From: Ray Kim Date: Mon, 20 Nov 2023 23:40:05 +0000 Subject: [PATCH] refactor docstring for rankplot --- src/rankplot.jl | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/src/rankplot.jl b/src/rankplot.jl index 981219b..8ffa35c 100644 --- a/src/rankplot.jl +++ b/src/rankplot.jl @@ -1,5 +1,6 @@ -""" +@userplot RankPlot +@doc """ rankplot(test, ranks; kwargs...) Plot the simulated ranks using `simulate_ranks`. @@ -14,10 +15,7 @@ Plot the simulated ranks using `simulate_ranks`. # Keyword Arguments - `stats_names`: The name for the statistics used in the rank simulation. The default argument automatically assign default names. (Default: :auto). - Keyword arguments corresponding `Plots` attributes, such as `bins`, `layout`, `size`, may apply. -""" -function rankplot end - -@userplot RankPlot +""" rankplot @recipe function f(h::RankPlot; stat_names = :auto) if length(h.args) != 2 || !(typeof(h.args[1]) <: ExactRankTest) error("rankplot should be given a `<: ExctRankTest` as first argument. Got: $(typeof(h.args)).")