Improve docs re data types for the Elements
Open
Nobody has claimed this yet.
docs 📜
- Dominant language
- Python
- Stars
- 394
- Forks
- 95
- Avg merge
- 4d 3h
- Merged PRs (30d)
- 7
Description
Originally reported by @ilan-gold via Zulip.
Hello! A very simple question/request - how would I find out what the type of Images is from the documentation https://spatialdata.scverse.org/en/stable/api/SpatialData.html#spatialdata.SpatialData.images xarray? dask?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the SpatialData.images API documentation linked in the issue and inspect the corresponding SpatialData element definition to identify the documented type. Update the documentation so readers can determine what type of object Images contains, then verify that the rendered API page answers the xarray-versus-dask question.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100