Confusing return type in many solvers
Open
documentation
good first issue
- Dominant language
- Python
- Stars
- 1.1k
- Forks
- 76
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 1
Description
For example, in LBFGS

Reading the Return type, it would seem like this returns an object of type OptStep, while in reality, it returns a tuple, of which the second argument is of type OptStep
Contributor guide
Research direction
Start with the LBFGS solver entry point and compare its documented return type with the tuple described in the issue. Inspect the corresponding return documentation or annotations across the other solvers, then verify that each documented return value matches what the solver actually returns.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- machine-learning
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100