You are reading documentation for the unreleased version of Matplotlib. Try searching for the released version of this page instead?
Applications are open for the 2018 John Hunter Matplotlib Summer Fellowship. Apply now!
Version 2.2.2.post1739+g2eb26ee35
matplotlib
Fork me on GitHub

matplotlib.artist.kwdoc

matplotlib.artist.kwdoc(artist)[source]

Inspect an Artist class and return information about its settable properties and their current values.

It use the class ArtistInspector.

Parameters:
artist : Artist or an iterable of Artists
Returns:
string

Returns a string with a list or rst table with the settable properties of the artist. The formating depends on the value of rcParams["docstring.hardcopy"]. False result in a list that is intended for easy reading as a docstring and True result in a rst table intended for rendering the documentation with sphinx.