Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 1269f62

Browse files
author
navdeep rana
committed
Added incompatibility of kwargs *shrink* and *aspect* with *cax* to the documentation.
1 parent 1dc1d8d commit 1269f62

File tree

1 file changed

+3
-8
lines changed

1 file changed

+3
-8
lines changed

lib/matplotlib/colorbar.py

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -175,14 +175,9 @@
175175
If *mappable* is a :class:`~matplotlib.contours.ContourSet`, its *extend*
176176
kwarg is included automatically.
177177
178-
Note that the *shrink* kwarg provides a simple way to keep a vertical
179-
colorbar, for example, from being taller than the axes of the mappable
180-
to which the colorbar is attached; but it is a manual method requiring
181-
some trial and error. If the colorbar is too tall (or a horizontal
182-
colorbar is too wide) use a smaller value of *shrink*.
183-
Further, *shrink* and *cax* kwargs are incompatible with each other and
184-
*shrink* applies only if the colorbar makes its own Axes by sharing space
185-
with the Axes in which it resides.
178+
The *shrink* kwarg provides a simple way to scale the colorbar with respect
179+
to the axes. Note that if *cax* is specified it determines the size of the
180+
colorbar and *shrink* and *aspect* kwargs are ignored.
186181
187182
For more precise control, you can manually specify the positions of
188183
the axes objects in which the mappable and the colorbar are drawn. In

0 commit comments

Comments
 (0)