docs: elaborate on example
This commit is contained in:
parent
fb7e6141ca
commit
a704736636
1 changed files with 6 additions and 0 deletions
|
@ -46,6 +46,10 @@ Planned features:
|
||||||
|
|
||||||
** Example format
|
** Example format
|
||||||
|
|
||||||
|
* =>= prefixes PR metadata and diff content from GitHub
|
||||||
|
* =<= prefixes existing review comments (to be implemented)
|
||||||
|
* Lines without prefixes are your review content: the review body above the first =>=, and individual inline comments in the diff sections
|
||||||
|
|
||||||
#+begin_src
|
#+begin_src
|
||||||
This is the review's body. Markdown *is*
|
This is the review's body. Markdown *is*
|
||||||
supported throughout the body and your
|
supported throughout the body and your
|
||||||
|
@ -55,6 +59,8 @@ by a single newline are joined together.
|
||||||
Paragraphs are two newlines of separation.
|
Paragraphs are two newlines of separation.
|
||||||
> [#241] @author: PR title
|
> [#241] @author: PR title
|
||||||
>
|
>
|
||||||
|
> The description of the PR.
|
||||||
|
>
|
||||||
> diff --git a/test.md b/test.md
|
> diff --git a/test.md b/test.md
|
||||||
> index aa9e6ef..ae07d61 100644
|
> index aa9e6ef..ae07d61 100644
|
||||||
> --- a/test.md
|
> --- a/test.md
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue