diff --git a/README.md b/README.md index d45e1ba..feb5a13 100644 --- a/README.md +++ b/README.md @@ -87,6 +87,16 @@ This means that reactions to comments will appear to be made by the user account commands: deploy, integration-test, build-docs ``` +### How are comments parsed for slash commands? + +Slash commands must be placed in the first line of the comment to be interpreted as a command. + +- The first character must be a `/` +- The slash command extends to the last non-whitespace character on the first line +- Anything after the first line is ignored and can be freely used for comments + +![Comment Parsing](docs/assets/comment-parsing.png) + ## Handling dispatched commands ### Event types diff --git a/docs/assets/comment-parsing.png b/docs/assets/comment-parsing.png new file mode 100644 index 0000000..83e5a57 Binary files /dev/null and b/docs/assets/comment-parsing.png differ