FrankWolfe.jl icon indicating copy to clipboard operation
FrankWolfe.jl copied to clipboard

Published 20 hours ago • verified publisher icon ZIB-IOL

Document algorithm arguments

Open gdalle opened this issue 2 years ago • 2 comments

Hey there! I'm playing more and more with your package, and I find it difficult to understand what every kwarg refers to, eg. here: https://github.com/ZIB-IOL/FrankWolfe.jl/blob/7e8e3c8e397e1967220624bd27f0ed537337d278/src/afw.jl#L10-L35 Would it be possible to add a brief one-liner for each argument to the documentation?

gdalle avatar May 05 '22 17:05 gdalle

I agree it would be great to have an explanation for each of them. Not sure whether the docstring or the docs directly would be better as a location

matbesancon avatar May 06 '22 07:05 matbesancon

I would put them in the docstring so that they can be displayed in the REPL

gdalle avatar May 06 '22 09:05 gdalle