pydata / pydata/xarray-data

Expose a html repr for all datasets somewhere?

Open
#39 2 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
43
Forks
21
PR merge metrics
No merged PRs in 30d

Description

I just took way to long to cycle through all datasets in order to find a dataset that fits my requirements. I think it would be super useful to have a small gallery/page that just shows the html repr for all datasets (automatically updated by CI). This could be integrated into the tutorial loading/opening functionsdocstrings.

Where would the best location for this be?

Happy to look into this when time is available.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked xarray/tutorial.py docstrings and inspect how tutorial datasets are loaded and opened. Determine where a gallery of HTML representations belongs and how CI could update it. Done means every dataset has an automatically updated, browsable HTML representation and the relevant tutorial entry point links to it.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.