plot_config#

Module containing plot configuration.

Functions#

Summary

create_parameter_docstring_mapping

Create a mapping of parameter names and they docstrings.

extract_default_kwargs

Extract the default kwargs of func from its signature.

find_axes

Iterate over values and yield the values that are Axes.

find_not_user_provided_kwargs

Find which kwargs of a function were not provided by the user.

plot_config_context

Context manager to override parts of the resolved functions PlotConfig.

use_plot_config

Decorate plot functions to register it and enables auto use of config.

Classes#

Summary

DefaultKwarg

Default value and type annotation of a kwarg extracted from the function signature.

PerFunctionPlotConfig

Per function plot configuration.

PlotConfig

Config for plot functions including default args and label overrides.

PlotLabelOverrideMap

Mapping to override axis labels.

PlotLabelOverrideValue

Value of PlotLabelOverrideMap.