Skip to content

Command-level descriptions #17

Open
@nergal-perm

Description

@nergal-perm

Add a special optional section to the command files. Something like:

description:
  summary: "This is a command that initializes a state for an application"
  arguments:
    - name: "startingPlayer"
      type: "string"
      description: "The id of the first player to make a move"

The description like that can be used as a documentation, and it also can be presented in a Logic Checker WebUI tool to provide the context for the designer or user.

Metadata

Metadata

Assignees

No one assigned

    Labels

    questionFurther information is requested

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions