Overview

Concepts and Principles

Development

Overview

IDEs

API Explorer

Releases

Release Notes

TORO Integrate

Coder Studio

Coder Cloud

Bug Reports

Search

Documenting

To provide explanations, or more information about your Flux Service, comments are supported. All comments are defined on the Flux definition itself. This means that when you need to pass around your service, comments will go along with it. You can add comments for the whole service or be specific and add one for each state.

To add comments to a service:

  1. Click any blank part of the canvas to access Flux Properties.
  2. Click the Comments tab.

Adding comments to a Flux Service

To add comments to a state:

  1. Click the desired state to access State Properties.
  2. Click the Comments tab.

Hovering your mouse to the state will show the comments for that state.

Adding comments to a Flux State

To add comments to the service:

  1. Click any blank part of the canvas to access Flux Properties.
  2. Double click the Comments property. A dialog will prompt you to add comments for the service.

Adding comments to a Flux Service

To add comments to a state:

  1. Click the desired state to access State Properties.
  2. Double click the Comments property. A dialog will prompt you to add comments for the state.

Hovering your mouse to the state will show the comments for that state.

Adding comments to a Flux State