FrankWolfe.jl
FrankWolfe.jl copied to clipboard
Document algorithm arguments
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?
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
I would put them in the docstring so that they can be displayed in the REPL