Add better documentation on specifying custom values.
Open
Beginner friendly
Nobody has claimed this yet.
documentation
- Dominant language
- R
- Stars
- 21
- Forks
- 14
- PR merge metrics
- No merged PRs in 30d
Description
Upon reading the user manual custom example, it's not spelled out that the user should put in the actual parameter values desired
From #188
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
Open the linked SSMSE manual section, “Example using custom pattern instead of model_change,” and read the surrounding explanation. Update the documentation to state explicitly that users should provide the actual parameter values they want. Done means the custom example clearly explains what values to enter.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100