Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Link UHI+ docs, add shorthands to quickstart #539

Open
andrzejnovak opened this issue Sep 18, 2023 · 2 comments
Open

[DOCS] Link UHI+ docs, add shorthands to quickstart #539

andrzejnovak opened this issue Sep 18, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@andrzejnovak
Copy link
Member

andrzejnovak commented Sep 18, 2023

  • We've had reports of people struggling to find the UHI+ indexing, should feature more prominently in README and the docs.
  • Also doc quickstart should include quickhand syntax which is less daunting and more commonly used
@andrzejnovak andrzejnovak added the documentation Improvements or additions to documentation label Sep 18, 2023
@henryiii
Copy link
Member

AFACT, both README and Quickstart do use UHI+, and the QuickConstruct syntax (Quickstart does show both)?

@andrzejnovak
Copy link
Member Author

Hmm, when I search README I only see this bit which doesn't imo look significant to new users.
image

hist's main indexing page https://hist.readthedocs.io/en/latest/user-guide/indexing.html should either link or copy info at https://uhi.readthedocs.io/en/latest/indexing.html#slicing

Also the super useful hist.tag.Slicer() functionality is missing here. Actually as far as I can tell this only lives in the docs in the API reference.

By "quickhand" I meant syntax like hist.new.Reg(10, 0, 1).Weight().fill(...) which doesn't seem to be what's at https://hist.readthedocs.io/en/latest/user-guide/quickstart.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants