From 7a381217a7508434ba3ee49d5ebde7ca4e7f8b7d Mon Sep 17 00:00:00 2001 From: Gunar Gessner Date: Tue, 27 Jul 2021 12:09:26 +0100 Subject: [PATCH] Explain `delete` a bit more (#372) * Explain `delete` a bit more * Apply suggestions from code review Co-authored-by: marocchino --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c5bdf1f..448bb07 100644 --- a/README.md +++ b/README.md @@ -107,6 +107,7 @@ with: ```yaml uses: marocchino/sticky-pull-request-comment@v2 with: + header: delete: true ``` @@ -131,7 +132,7 @@ is explicitly passed, this problem can be solved by just removing it. ### `delete` -**Optional** Delete the previously created comment. Only `true` is allowed. Just skip this option when you don't need it. +**Optional** Delete a previously created comment. Use `header` to point to which comment you want to delete. Only `true` is allowed (i.e. delete this option if you don't need it). ### `message`