Skip to content

Commit e53cff0

Browse files
committed
update docstring for builderplot
1 parent ec79366 commit e53cff0

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

src/plot.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Two panel visualization of gridfactory with input and resulting grid
2121
- `layout`: layout of grid visualizer
2222
- `vis`: grid visualizer
2323
- `circumcircles`: plot circumcicles in output
24-
- `reveal`: reveal plot upon return
24+
- `reveal`: reveal plot upon return. If `revel==true`, `reveal(vis)` is returned, and the plot is shown automatically. If `revel==false`, the visualizer `vis` is returned, giving the user the possibility to add plots in other visualizer slots.
2525
- `kwargs...`: passed to output constructor; see [`default_options`](@ref) for available `kwargs`.
2626
"""
2727
builderplot(gb::SimplexGridBuilder; Plotter = nothing, kwargs...) = builderplot(gb, Plotter; kwargs...)

0 commit comments

Comments
 (0)