User option cleanup
Open
Nobody has claimed this yet.
to do
- Dominant language
- Python
- Stars
- 1.5k
- Forks
- 560
- Avg merge
- 1h 41m
- Merged PRs (30d)
- 3
Description
- Change "user option" terminology to "setting". (Maybe.)
- Option name normalization. Use a reverse-DNS style naming.
- Correct issues when merging options from different sources, such as keyword arguments, options dict, config file, etc. There needs to be a clearly defined priority for option sources.
-
Some options need special handling for merging, such aspackwhere you probably want to just combine the set of packs from all sources into a single list. - Improve handling of option value conversion by having per-option conversion handler callables. (Not sure this is really necessary, at least currently.)
- Provide default values in the
OptionInfoobjects. - Fill in default values of all options if not set explicitly from one or other sources.
- Support notifications on option value changes.
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 by locating the OptionInfo implementation and the code that merges option sources. Review the unchecked items, especially terminology, option-name normalization, and per-option value conversion, then determine which requirements remain in scope. Done would require resolving the open checklist items and documenting or testing the resulting option behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100