Skip to content

Commit 1a5201c

Browse files
authored
Merge pull request #34 from peter-evans/update-docs
Update documentation
2 parents 5a52896 + bdde59f commit 1a5201c

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,16 @@ This means that reactions to comments will appear to be made by the user account
8787
commands: deploy, integration-test, build-docs
8888
```
8989

90+
### How are comments parsed for slash commands?
91+
92+
Slash commands must be placed in the first line of the comment to be interpreted as a command.
93+
94+
- The first character must be a `/`
95+
- The slash command extends to the last non-whitespace character on the first line
96+
- Anything after the first line is ignored and can be freely used for comments
97+
98+
![Comment Parsing](docs/assets/comment-parsing.png)
99+
90100
## Handling dispatched commands
91101

92102
### Event types

docs/assets/comment-parsing.png

77.4 KB
Loading

0 commit comments

Comments
 (0)