Skip to content
This repository has been archived by the owner on Jan 27, 2023. It is now read-only.

Documentation of histogram methods #25

Open
jpivarski opened this issue Dec 14, 2018 · 2 comments
Open

Documentation of histogram methods #25

jpivarski opened this issue Dec 14, 2018 · 2 comments

Comments

@jpivarski
Copy link
Member

I've moved the issue here from scikit-hep/uproot3#193. It could be part of a long README, a Binder notebook, a wiki, or REsT for uproot-methods.readthedocs.org; I'm not sure. Ideas, @HDembinski?

@HDembinski
Copy link
Member

I like READMEs with some minimal kick-start examples, and then a link to a full-blown tutorial. For a full-blown tutorial, a Binder notebook is the nicest solution, I guess.

@HDembinski
Copy link
Member

The idea of the README in my view is to throw a bone to the unsure potential user, who is taking quick looks into a few similar libraries and will stick to the one which seems simplest to use.
For uproot-methods, you could argue that it is already a technical package, which you will only look into when you already decided to go for uproot. So maybe the bone throwing is not necessary here (which is why I would have preferred to have it in the readme of uproot).

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants