Skip to content

[DOCS] Show possible kwargs in either docstring or website #617

@GuillermoFidalgo

Description

@GuillermoFidalgo

It's not very obvious to the user what the possible kwargs could be for things like plot_ratio and plot_pull just by looking at the documentation page.

It might be useful to list those that are not standard or at least mention something like
**kwargs – Keyword arguments passed to underlying matplotlib function - pcolormesh. (example from hist2dplot)
This example in particular led me to find a very useful solution to easily change the scale of the colors to log by using the norm= "log" kwarg.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions