lincc-frameworks / lincc-frameworks/hyrax
Review the use of `false` in `hyrax_default_config.toml`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 41
- Forks
- 7
- Avg merge
- 5d 1h
- Merged PRs (30d)
- 8
Description
It seems that we might have gone too far in our use of `false` as the default "no value" value. There are cases where an empyt string makes more sense.
Either `false` or `""` will work with the existing logic that we've been using, but the empty string could be a more intuitive value in some instances. For instance `[model][name] = ""` might be more clear for a new user that the model name needs to be provided, where as a `false` values might imply something else.
On the contrary, `[general][dev_mode] = false` makes a lot more sense than a `""` value.
Contributor guide
No contributing guide indexed for this repository
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
Open hyrax_default_config.toml and review each false default against the existing logic and the examples in the issue, especially model.name and general.dev_mode. Trace where these defaults are consumed, then confirm that the chosen values make the configuration clearer without changing valid 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
- Mostly clear
- Newbie friendliness
- 45/100