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

Add values of default arguments in docstrings #238

Merged
merged 1 commit into from
Nov 19, 2020

Conversation

frapac
Copy link
Contributor

@frapac frapac commented Nov 18, 2020

That allows to read the default values of the arguments with the help?> function, directly in Julia's REPL.

Note: By default, maxit is set to 2 * length(b) whenever maxit=0. Should we specify this value directly in the args?

@amontoison
Copy link
Member

If the matrix is rectangular itmax=n+m with (n,m) = size(A). But we should add in the doc that itmax=0means itmax=2n if the matrix is square, otherwise itmax=n+m.

@frapac
Copy link
Contributor Author

frapac commented Nov 18, 2020

I see. I will update the PR accordingly.

@dpo dpo merged commit 4ed2302 into JuliaSmoothOptimizers:master Nov 19, 2020
@dpo
Copy link
Member

dpo commented Nov 19, 2020

Thank you!

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

Successfully merging this pull request may close these issues.

None yet

3 participants