Add check for undocumented names; remove a dangling exported function

CHANGELOG.md

@@ -6,6 +6,12 @@
 
 - `gridplot` with `GLMakie` and `PyPlot` now annotates the color bars with `boundary regions` and `cell regions`
 
+- unit test for undocumented names
+
+### Removed
+
+- dangling exported function `backend!`
+
 ## [1.9.0] - 2024-11-25
 
 ### Added

docs/src/api.md

@@ -61,3 +61,8 @@ available_kwargs
 vectorsample
 quiverdata
 ```
+
+## Creating movies
+```@docs
+movie
+```

docs/src/index.md

@@ -1,6 +1,5 @@
-````@eval
-using Markdown
-Markdown.parse("""
-$(read("../../README.md",String))
-""")
-````
+# GridVisualize.jl
+
+```@docs
+GridVisualize
+```

src/GridVisualize.jl

@@ -1,3 +1,8 @@
+"""
+    GridVisualize
+
+$(read(joinpath(@__DIR__, "..", "README.md"), String))
+"""
 module GridVisualize
 
 using Printf
@@ -31,7 +36,7 @@ export gridplot, gridplot!
 export vectorplot, vectorplot!
 export streamplot, streamplot!
 export customplot, customplot!
-export save, reveal, backend!
+export save, reveal
 export isplots, isvtkview, ispyplot, ismakie, isplutovista
 export GridVisualizer, SubVisualizer
 export plottertype, available_kwargs

src/makie.jl

@@ -77,6 +77,12 @@ function save(fname, scene, XMakie, ::Type{MakieType})
     return isnothing(scene) ? nothing : XMakie.save(fname, scene)
 end
 
+
+"""
+    movie( func, vis::GridVisualizer, ::Type{MakieType}; file = nothing, format = "gif", kwargs... )
+
+Record a movie with GLMakie backend. MP4 files and gifs can be created.
+"""
 function movie(
         func,
         vis::GridVisualizer,

src/plots.jl

@@ -46,6 +46,11 @@ function save(fname, scene, Plots, ::Type{PlotsType})
     return isnothing(scene) ? nothing : Plots.savefig(scene, fname)
 end
 
+"""
+    movie( func, vis::GridVisualizer, ::Type{PlotsType}; file = nothing, format = "gif", kwargs... )
+
+Record a movie with Plots backend. MP4 files and gifs can be created.
+"""
 function movie(
         func,
         vis::GridVisualizer,

test/runtests.jl

@@ -8,3 +8,10 @@ include("../docs/makeplots.jl")
 @testset "makeplots - CairoMakie" begin
     makeplots(mktempdir(); Plotter = CairoMakie, extension = ".svg")
 end
+
+
+if isdefined(Docs, :undocumented_names) # >=1.11
+    @testset "UndocumentedNames" begin
+        @test isempty(Docs.undocumented_names(GridVisualize))
+    end
+end