nmfs-ost / nmfs-ost/fishdictionary
Alternatives doesn't indicate terms that should not be used
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 5
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
The 'Alternative' category in the .R files does not delineate between terms that should and should not be used. Alternatives, perhaps this should be renamed and/or a new category should be added such as synonyms. I am just trying to work out how users will know which term they should use if an alternative also has a definition and the words are essentially synonyms. Or, would the previous NEVER happen because synonyms would only be listed in the alternative category and not have their own .R file. This is coming up for me because of forecast vs. projection. They are not really alternatives of each other but I would like some way to link them so users know they should look at both definitions before deciding which term applies to their situation.
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 Alternative category in the .R files, starting with the forecast and projection terms described in the issue. Decide how the dictionary should distinguish preferred terms from synonyms or other related alternatives, and consider whether the category name or an additional category needs to change; the work is done when users can tell which terms to use and which definitions to compare.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100