redback.plotting.get_plotter_kwargs_docs

redback.plotting.get_plotter_kwargs_docs(plotter_class=None)[source]

Return a formatted string documenting all kwarg options for a Plotter class.

Introspects the class for KwargsAccessorWithDefault descriptors and prints each option with its default value. This is the canonical way to discover what can be passed as **kwargs to transient.plot_data(), plot_multiband(), plot_lightcurve() etc.

Parameters:: plotter_class (type, optional) – A Plotter subclass to inspect. Defaults to Plotter.
Returns:: Formatted documentation string.
Return type:: str

Example:

import redback.plotting
print(redback.plotting.get_plotter_kwargs_docs())
# or for MagnitudePlotter specifically:
print(redback.plotting.get_plotter_kwargs_docs(redback.plotting.MagnitudePlotter))