astropy / astropy/pyregion

Move example data files to `pyregion.datasets`?

Open
#50 2 comments 0 reactions 0 assignees View on GitHub
docs
Dominant language
Python
Stars
41
Forks
41
PR merge metrics
No merged PRs in 30d

Description

Should we move the example data files that are used in the docs (e.g. `docs/figures/pspc_skyview.fits` or `docs/figures/test.reg`) to `pyregion.datasets` to make the docs examples work for the user out of the box?

@astrofrog If you agree, this is something I could do tomorrow, it's not much work.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the documentation references to docs/figures/pspc_skyview.fits and docs/figures/test.reg, then inspect how pyregion.datasets could expose those files. Confirm the intended location and packaging approach before making changes; done means the documentation examples work for users out of the box.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 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.