Better function names about mplhep HOT 8 CLOSED

I'm open to renamings, but I would want to avoid overlap with pyplot namespace in case we ever switch to monkeyclassing

from mplhep.

You should not try to avoid name clashes. We have namespaces to resolve the ambiguity. That's the reason everyone writes plt.hist instead of just hist, so that this package can also have a hist.

from mplhep.

Look at cupy, jax, etc, these re-implement the numpy interface with the exact same names and calling conventions under a different namespace, precisely so that you can do

# import numpy as np
from jax import numpy as np

# do numpy stuff

from mplhep.

from mplhep.

Ok, you are right, it is not exactly the same situation. If I understand correctly, you are already preparing for a possible merging of mplhep into pyplot. I think this is not going to happen very soon, and even when it is, the names will be debated again anyway. You cannot anticipate how that merging will go. The matplotlib guys could decide to place this in mpl_toolkit, then you would have an extra namespace anyway.

For now, we should use names that are easy to type. I like the idea of imitating the pyplot.hist and hist2d interface, so that it is easy to switch over and you do not have to relearn another interface, that is great. However, the following should work

mplhep.hist(*np.histogram(data))

from mplhep.

@HDembinski Would you find it a reasonable solution to alias the two for now? hist = histplot, hist2d = hist2dplot ?

from mplhep.

Yes, and to deprecate histplot and hist2dplot.

from mplhep.

This is the deprecation decorator I use in iminuit, feel free to copy this or allow me to make a PR with the change.
https://github.com/scikit-hep/iminuit/blob/develop/iminuit/_deprecated.py

from mplhep.