From a5011faa5982b0c11824d40f38ad97aa700b813b Mon Sep 17 00:00:00 2001
From: Nico Korthout <nicokorthout@gmail.com>
Date: Wed, 21 Aug 2024 09:43:02 +0200
Subject: [PATCH] docs: clarify source_pr_number input behavior

Note that this is not specific to the workflow_dispatch event type. It
should also work for other event types.
---
 action.yml | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/action.yml b/action.yml
index da16734..1f4cca8 100644
--- a/action.yml
+++ b/action.yml
@@ -118,8 +118,9 @@ inputs:
       [Backport ${target_branch}] ${pull_title}
   source_pr_number:
     description: >
-      Specifty the pull request number to backport instead of detecting based on the pull request closed event.
-      Only valid when github.event_type == "workflow_dispatch".
+      Specifies the pull request (by its number) to backport, i.e. the source pull request.
+      When set, the action will backport the specified pull request to each target branch.
+      When not set, the action determines the source pull request from the event payload.
   target_branches:
     description: >
       The action will backport the pull request to each specified target branch (space-delimited).