Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More documentation issues #213

Open
jlbosse opened this issue May 13, 2022 · 1 comment
Open

More documentation issues #213

jlbosse opened this issue May 13, 2022 · 1 comment

Comments

@jlbosse
Copy link

jlbosse commented May 13, 2022

The docstring for curve_fit() does not mention that curve_fit() accepts kwargs and
that these get forwarded to LsqFit.levenberg_marquardt(). This made me miss the
options upper and lower (as described here first. The docs at https://julianlsolvers.github.io/LsqFit.jl/latest/ also don't mention upper or lower anywhere.

I am happy to create a PR to fix that, just tell me whether

  1. You want me to update the docstring of curve_fit() to include kwargs and mention they get forwarded to levenberg_marquardt().
  2. You want me to find out why the docstring for neither levenberg_marquardt() nor the struct LevenbergMarquardt show up. There is a docstring for LevenbergMarquardt in the docs, but it doesn't show up in the REPL.
  3. You want me to add an example of the usage of upper and lower to the examples in the tutorial or API reference section of the docs.
@nluetts
Copy link

nluetts commented Sep 14, 2022

I had the exact same problem, would be great if the docs would be more explicit w.r.t. the kwargs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants