Skip to content

Function docstring could replace algorithm description #3

@MalloryWittwer

Description

@MalloryWittwer

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__).

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions