Skip to content

Improve Documentation by Providing Function List #161

@nkh0472

Description

@nkh0472

Currently, documentation is only available on a per-function basis. Thus, I believe listing the available functions could prove quite useful. If users are unaware of these functions' existence, they won't know the full capabilities of the toolbox or what to learn. This list could be included in the README file (initially collapsed as it might be lengthy), saved as a CSV in the root folder, or displayed in MATLAB in some manner.

The MathWorks File Exchange has already compiled such a list. It might be unnecessary to duplicate this effort in the source code.

However, I suggest not redirecting users to MathWorks for learning purposes. Instead, placing the function list in the root folder would allow users to easily locate it.

An example function list.csv

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions