Include standard parameter nomenclature in the plugin model docs
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 65/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- python
- Domain
- documentation
Research direction
Read issue #305 for the list of parameters used across models, then inspect the existing plugin model documentation to find where model conventions are described. Move or incorporate the parameter list into those docs so plugin authors can consult the standard nomenclature; done when the documentation includes the list and makes the naming convention clear.
Written by the indexing model from the issue text.
Description
When reviewing new models a frequent request is to rename the parameters to follow the standard nomenclature.
#305 gives a list of all parameters in all models. By moving this list to the docs, plugin authors may be more likely to follow the existing conventions for their models.
- Dominant language
- Python
- Stars
- 23
- Forks
- 32
- Avg merge
- 7d 20h
- Merged PRs (30d)
- 2
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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.
More from SasView/sasmodels
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
SasModels Infrastructure SasView coordination
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
SasModels Infrastructure
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 3/5 Half a day Newbie friendliness 35/100
All issues in SasView/sasmodels
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
huggingface/sentence-transformers#4186 ·
Maintainers usually reply within 5 days
-
documentation
Difficulty 1/5 Under an hour Newbie friendliness 92/100
QuantEcon/QuantEcon.py#988 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
fabriziosalmi/certmate#1247 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 1 day
-
documentation good first issue
Difficulty 2/5 Half a day Newbie friendliness 72/100
sujithputta02/Esapay#13 ·