metrumresearchgroup / metrumresearchgroup/nmrec
Consider maintaining/exposing set of all valid options for given record
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- R
- Stars
- 1
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
In gh-1, the idea of maintaining the set of valid options for a record came up for two reasons:
- doing so would enable
get_record_optionto error if an unknown option is passed - exposing it could be helpful for developers
The main complication is that *_option_names environment for records covers most of the options, but some are missing:
option_posnames (that includesoption_nested, which is a subclass ofoption_pos)- the names in
matrix_prefix_options - the
option_record_nameoption (not very interesting)
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
Review the existing *_option_names environment for records, along with get_record_option, option_pos and option_nested, matrix_prefix_options, and option_record_name. Determine how the complete valid-option set should be maintained and exposed, and define behavior for unknown options before considering the work complete.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100