Skip to content

[FEEDBACK]: Automatic Sequencer Documentation #86

Description

@TeraMika

Is your feature request related to a problem? Please describe.
Sequencer documentation could probably be (at least mostly) automated through docstrings and comments.

Describe the solution you'd like
There exist tools to generate documentation from code. These could be used to write most of the sequencer manual and make it automatically update via GitHub Action.

Describe alternatives you've considered
Writing it manually is fine but it's very easy to miss things.

Additional context
This would require making sure that each attribute has adequate commentary to explain what it is and what its default type should be. This might be quite a lot of additional documentation work - so this issue may best be suited for later work after core features and bugs are resolved.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions