Skip to content

Lack of sufficient documentation #160

@BobTheHunted

Description

@BobTheHunted

Each parameter should be listed by name, and have it's functionality explain in two ways;

  1. What does it do, and how does it work, in a basic technical sense.
  2. What does this mean practically, how is it useful, how will it affect the output, explained in a more layman friendly way.

And of course visual examples are great, but that's a lot of extra effort. But if I can't Ctrl + F and type the word "asynchronously" for the option, "Run Asynchronously", I can't be expected to understand what that setting does.

And if that is the official documentation that is lacking, that means there are unexplained options that people won't know how to use. Why have it be an option at all?

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