Undocumented return values for CVodeB and IDASolveB
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 686
- Forks
- 167
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 17
Description
The sundials 7.1.1 documentation suggests that the only non-negative return value from CVodeB is CV_SUCCESS. However, it may also return CV_TSTOP_RETURN. (Unrelated: the last sentence in the Notes section of CVodeB is duplicated just below.)
The same applies to IDASolveB and IDA_TSTOP_RETURN.
I don't know whether *_TSTOP_RETURN should be added to the documentation, or whether these function should not return that at all. (Those return values can be observed, for example, in the cvsRoberts_ASAi_klu and idasRoberts_ASAi_klu examples.)
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
Start with the CVodeB and IDASolveB API documentation linked in the issue, then reproduce the return values using the cvsRoberts_ASAi_klu and idasRoberts_ASAi_klu examples. Compare the documented and observed non-negative returns, including the duplicated Notes sentence, and determine whether the documentation or function behavior needs correction.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100