Skip to content

Commit

Permalink
refactor docstring for rankplot
Browse files Browse the repository at this point in the history
  • Loading branch information
@Red-Portal
Red-Portal committed Nov 20, 2023
1 parent 32a735d commit 39ccd7d
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions src/rankplot.jl
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@

"""
@userplot RankPlot
@doc """
rankplot(test, ranks; kwargs...)
Plot the simulated ranks using `simulate_ranks`.
Expand All @@ -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)).")
Expand Down

2 comments on commit 39ccd7d

@Red-Portal
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/95678

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.2.0 -m "<description of version>" 39ccd7df10d53ad842f68547804d508432ae6678
git push origin v0.2.0

Please sign in to comment.