Review file
prr supports various review file markups. This document captures all of them.
Review directives
Description: Meta-directives to give to prr in review comment. Currently
only supports approving, requesting changes to, and commenting on a PR.
Syntax: @prr approve, @prr reject, or @prr comment.
Review comment
Description: PR-level review comment. You only get one of these per review.
Syntax: Non-whitespace, non-quoted text at the beginning of the review file.
Description comment
Description: Specialized form of review comment. When
activate_pr_metadata_experiment
is active, review files come with the PR description quoted at the top of the
review file. Comments, when uploaded, will quote the preceding description. PR
description will continue to be quoted until a review directive is found.
Syntax: Same as review comment.
Inline comment
Description: Inline comment attached to a specific line of the diff.
Syntax: None-whitespace, non-quoted text on a newline immediately following a quoted non-header part of the diff.
Spanned inline comment
Description: Like an inline comment, except it covers a span of lines.
Syntax: To start a span, insert one or more newlines immediately before a quoted, non-header part of the diff. To terminate a span, insert a inline comment.
File comment
Description: File-level comment.
Syntax: Non-whitespace, non-quoted text immediately following the diff --git header
Snips
Description: Use [...] to replace (ie. snip) contiguous quoted lines.
Syntax: [...] or [..] on its own line. Multiple snips may be used in a review file.