Swarm 2014.1: User Guide

Comments

Comments are the primary feedback mechanism provided by Swarm. Comments can be made on files in a review, on any lines of any text file in a review, and on jobs.

Emoji smile tooltip Swarm comments support Emoji short-hand; when you save a comment, emoticon text like :smile: is displayed as: Emoji smile. Hover your mouse over an Emoji emoticon to see a tooltip displaying the text short-hand for the emoticon.

Tip

For more information on Emoji, see Emoji at Wikipedia. Emoji emoticons are listed in the Emoji Cheat Sheet.

Links appearing in comments Whenever you include a URL in a comment, it is automatically made into a link. If the link points to an image, or a YouTube video, that resource is displayed at the end of the comment.

When comments are added to files in a review, on lines that have been changed, Swarm records several lines of context before the line receiving the comment. This helps makes sense of the comments should later changes remove those lines.

Commentary on a change, showing its context.

Each comment associated with that line has a record of the context, but only the first comment displays that context.

Commenting on a changelist or review

  1. Visit the changelist's or review's page.

  2. Comments tab on Reviews page

    Click Comments to view the comments tab.

  3. Comment area for a review

    Add your comment in the provided text area.

  4. Post button

    Click Post.

Commenting on a specific line in a file

  1. Visit the changelist's or review's page.

  2. Files tab

    Click Files to view the file tab.

  3. Click a line you want to comment on. The comment text area appears.

  4. Comment area in a diff

    Add your comment in the provided text area.

  5. Post button for Comments

    Click Post.

Commenting on a file in a changelist or code review

  1. Visit the changelist's or review's page.

  2. Files tab

    Click Files to view the file tab.

  3. If there are multiple files, click the file you want to comment on to expand its view.

  4. The link to add a comment to a file. Click the Add a Comment link in the footer of the file's display.

  5. Comment area in a diff Add your comment in the provided text area.

  6. Post button for Comments Click Post.

Note

You can use “@mentions” in comments. An @mention includes the specified user in the review, and they will receive a notification whenever there is an update to the review.

Archiving comments

As a code review progresses, comments made on earlier versions of a file may no longer be pertinent. If left unattended, comments may accumulate until it is difficult to determine which comments are still relevant and which comments have been addressed.

  1. The Comment Archive button Click the file drawer icon at the top right of a posted comment to archive it.

Archived comments are normally hidden from view. When archived comments exist, a box appears showing the number of archived comments. Click the box to toggle the presentation of all archived comments.

The Archived Comments box

Restore comments

A closed comment may be restored.

  1. Click the archived comments box to display all archived comments.

  2. Locate the comment you want to restore

  3. The Comment Restore button Click the arrow icon in the top right of the comment to restore it.

0 matching pages