astropy / astropy/regions

visual should validate keys/values

Open
#324 3 comments 1 reaction 0 assignees View on GitHub
feature-request metadata
Dominant language
Python
Stars
65
Forks
64
Avg merge
2d 13h
Merged PRs (30d)
4

Description

Currently, the ``.visual`` property is just a free-form dictionary which allows things such as:

```
region.visual['banana'] = 'apple'
```

We should make sure we validate the keys/values for this dictionary and make it easy for users to find out the keys that can be set (perhaps by setting some sensible defaults)

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the `.visual` property and examining how its dictionary currently accepts arbitrary keys and values. Determine the supported visual keys and values from the existing package behavior or project discussion, then ensure invalid entries are rejected and users can discover valid settings through sensible defaults; done means the requested validation and discoverability are covered by tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.