Skip to content

Commit 1144096

Browse files
committed
remove colorbar docstring
1 parent 1cc6c09 commit 1144096

File tree

1 file changed

+3
-9
lines changed

1 file changed

+3
-9
lines changed

src/guides/colorbar.jl

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,10 @@ function colorbar!(fg::FigureGrid; position=:right,
66
end
77

88
"""
9-
colorbar!(figpos, grid; kwargs...)::Vector{Colorbar}
9+
colorbar!(figpos, grid; kwargs...)
1010
11-
Compute zero or more colorbars for `grid` (which should be the output of [`draw!`](@ref)) and draw them in a
12-
nested `GridLayout` in position `figpos`. One colorbar will be drawn for each applicable scale.
13-
Attributes allowed in `kwargs` are the same as `MakieLayout.Colorbar`.
14-
15-
!!! note
16-
Before AlgebraOfGraphics v0.10, this function returned `Union{Nothing,Colorbar}`
17-
because multiple colorbars in a single figure were not supported. The name of the
18-
function was kept singular **colorbar** to be less breaking.
11+
Compute colorbar for `grid` (which should be the output of [`draw!`](@ref)) and draw it in
12+
position `figpos`. Attributes allowed in `kwargs` are the same as `MakieLayout.Colorbar`.
1913
"""
2014
function colorbar!(figpos, grid; vertical = true, kwargs...)
2115
colorbars = compute_colorbars(grid)

0 commit comments

Comments
 (0)