hist icon indicating copy to clipboard operation
hist copied to clipboard

[DOCS] add plot_pull documentation

Open DraTeots opened this issue 3 years ago • 1 comments

Hello! We are trying to use plot_pull in our analyses but unfortunately just providing a PDF function without other fit parameters like default values makes it rather not working than working. At the same time documentation about plot_pull currently looks like this

image

How do you want to improve the docs

  1. How the histogram is fitted (what method and engine is behind).
  2. How one provides initial values?
  3. How one retrieves obtained fit parameters?
  4. Can one lock values/refit?

Even the only example is not documented.

# plot pull
h.project("W").plot_pull(
    pdf,
    eb_ecolor="green",
    eb_mfc="green",
    eb_mec="green",
    eb_fmt="o",
    eb_ms=5,
    fp_color="lightseagreen",
    pp_color="darkgreen",
    pp_alpha=0.4,
    pp_ec=None,
    bar_color="darkgreen",
)
plt.show()

One may guess what those mean in general while pp_ec is really intriguing!

P.S. Please, documentation is needed more than features for such library.

DraTeots avatar Apr 26 '21 20:04 DraTeots

Thank you for reporting this issue, we will add the docs before the next release. Currently, plot_pull is calling plot_ratiolike which uses scipy.optimize fitter.

LovelyBuggies avatar Aug 11 '21 07:08 LovelyBuggies