Currently, we can add a short description inside @sk.algorithm. This description gets displayed on the HTML "info" page of the algorithm.
However, this isn't very practical for longer descriptions. Unless we see a particular interest in keeping this short description field, we could consider dropping it and rendering the algorithm's docstring instead (__doc__).
Currently, we can add a short
descriptioninside@sk.algorithm. This description gets displayed on the HTML "info" page of the algorithm.However, this isn't very practical for longer descriptions. Unless we see a particular interest in keeping this short description field, we could consider dropping it and rendering the algorithm's docstring instead (
__doc__).