|
405 | 405 | lw, linewidth, c, color : optional |
406 | 406 | Controls the line width and edge color for both the colorbar |
407 | 407 | outline and the level dividers. |
408 | | -orientation : {None, 'horizontal', 'vertical'}, optional |
409 | | - The colorbar orientation. By default this depends on the "side" of the subplot |
410 | | - or figure where the colorbar is drawn. Inset colorbars are always horizontal. |
| 408 | +%(axes.edgefix)s |
411 | 409 | rasterize : bool, optional |
412 | 410 | Whether to rasterize the colorbar solids. The matplotlib default is ``True`` |
413 | 411 | but we change this to :rcraw:`colorbar.rasterize` because rasterization can |
414 | 412 | cause misalignment between `edges` and the level patches. |
| 413 | +orientation : {None, 'horizontal', 'vertical'}, optional |
| 414 | + The colorbar orientation. By default this depends on the "side" of the subplot |
| 415 | + or figure where the colorbar is drawn. Inset colorbars are always horizontal. |
415 | 416 | **kwargs |
416 | 417 | Passed to `~matplotlib.figure.Figure.colorbar`. |
417 | 418 | """ |
| 419 | +_edgefix_docstring = """ |
| 420 | +edgefix : bool or float, optional |
| 421 | + Whether to fix the common issue where white lines appear between |
| 422 | + `filled contours <https://stackoverflow.com/q/8263769/4970632>`__ |
| 423 | + and `filled patches <https://stackoverflow.com/q/8263769/4970632>`__ |
| 424 | + in saved vector graphics. This can slow down figure rendering. Default |
| 425 | + is :rc:`cmap.edgefix`. If ``True``, a default linewidth is used to fix |
| 426 | + the edges. If float, this linewidth is used. |
| 427 | +""" |
| 428 | +docstring._snippet_manager['axes.edgefix'] = _edgefix_docstring |
418 | 429 | docstring._snippet_manager['axes.colorbar_args'] = _colorbar_args_docstring |
419 | 430 | docstring._snippet_manager['axes.colorbar_kwargs'] = _colorbar_kwargs_docstring |
420 | 431 |
|
|
0 commit comments