always make docstring of plot_structure_makie available

marcom · Dec 2, 2022 · 365e180 · 365e180
1 parent 6060741
commit 365e180
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 5 deletions.
diff --git a/src/PlotRNA.jl b/src/PlotRNA.jl
@@ -22,4 +22,17 @@ include("r2r.jl")
     #plot_structure_makie("(((...)))"; sequence="GGGAAACCC")
 end
 
+# We define the docstring of plot_structure_makie here so it's always
+# available, even if the plot_structure_makie implementation wasn't
+# included because CairoMakie was not loaded.
+"""
+    plot_structure_makie(structure; [sequence, savepath, layout_type, colorscheme])
+
+Plot a secondary structure to a PNG image or PDF file depending on `savepath` ending.
+
+Using this function requires CairoMakie to have been loaded before
+PlotRNA with `using CairoMakie, PlotRNA`.
+"""
+function plot_structure_makie end
+
 end # module PlotRNA
diff --git a/src/plot_structure_makie.jl b/src/plot_structure_makie.jl
@@ -4,11 +4,6 @@ using .CairoMakie: Makie, Axis, Colorbar, ColorTypes, DataAspect, Figure,
     hidedecorations!, hidespines!, lines!, scatter!, text!,
     xlims!, ylims!
 
-"""
-    plot_structure_makie(structure; [sequence, savepath, layout_type, colorscheme])
-
-Plot a secondary structure to a PNG image or PDF file depending on `savepath` ending.
-"""
 function plot_structure_makie(
     structure::AbstractString;
     sequence::AbstractString=" "^length(structure),