Document each fitter
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
Currently if a fitter cannot convert you get this message:
"""
Unable to guess coefficients, using defaults.
Coefficient Guesses: 100000000000.0 20.0 7.81
Was unable to find a reasonable fit.
Please try to find better guesses for all this fit_type's parameters.
"""
This is OK, but it would be nice if we could list what those fit parameters are. Then the user wouldn't have to look them up.
Information about the coeffience guesses would be good too, which parameters do those guesses pertain to?
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
Start with the fitter error output and the definitions for each fit_type's parameters. Document which parameters the coefficient guesses correspond to and include those names when a fit fails. Done means users can identify the fitted parameters and interpret the displayed guesses without looking them up elsewhere.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100