Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

Description is an additional multiline text that can be attached to an item. It can contain long notes and details that don't need to be immediately visible when looking at a checklist.


Info

Description consists of all lines which follow the checkbox item and start with ">>" characters. 

Description can be added through Editor or Checklist Text custom field. 

How to add description in Editor

To add a description, open the checklist in the editor and add description in the lines below the item to which the description should be attached.

...

The checklist from the example above will render as in the following screenshot:

How descriptions are presented in a checklist

If an item has description there will be a link below it titled "Show description". When clicked, description will be shown below the item, but this view will be read-only - descriptions can be added, modified and removed only through the editor.

Advanced formatting and additional elements in descriptions

Descriptions don't necessarily have to consist only of plain text - they can span multiple lines, be formatted using markdown and contain and consist advance formatting elements (markdown, inline code, user mentions, due dates and issue keys that will be automatically linked to issuesRead more about advanced formatting, etc.).

For example, the following checklist:

...