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

Published 20 hours ago • verified publisher icon andrewrosemberg

Improve function docs and structs

Open Thuener opened this issue 5 years ago • 0 comments

Improve function docs expecially the ones that get exported.

Some good examples: functions https://github.com/odow/SDDP.jl/blob/88a2b0e8217e3e0b0ab4ef776a0c7534f5768156/src/user_interface.jl#L113 https://github.com/JuliaGraphs/LightGraphs.jl/blob/adb43fb374266398540ed7073e8b5037ea76f852/src/shortestpaths/yen.jl#L12

Structs https://github.com/odow/SDDP.jl/blob/88a2b0e8217e3e0b0ab4ef776a0c7534f5768156/src/plugins/risk_measures.jl#L61 https://github.com/odow/SDDP.jl/blob/88a2b0e8217e3e0b0ab4ef776a0c7534f5768156/src/plugins/risk_measures.jl#L115

Thuener avatar Apr 16 '19 12:04 Thuener