docs: clarify experimental downstream inputs

tasso94 · May 3, 2024 · 12c1d74 · 12c1d74
1 parent 79396b7
commit 12c1d74
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -169,20 +169,18 @@ When enabled, the action detects the method used to merge the pull request.
 
 By default, the action always cherry-picks the commits from the pull request.
 
-### Backport to a downstream
-
-Backport PR to another repository then the workflow runs on.
-
 ##### `downstream_repo`
 
-Define if you want to backport to another repository then the workflow runs on.
+Define if you want to backport to a repository other than where the workflow runs.
+
+By default, the action always backports to the repository in which the workflow runs.
 
 ##### `downstream_owner`
 
-Define if you want to backport to another owner then the owner of the repository the workflow runs on.
+Define if you want to backport to another owner than the owner of the repository the workflow runs on.
+Only takes effect if the `downstream_repo` property is also defined.
 
-Only specify together with the `downstream_repo` property.
-If undefined, uses the owner of the repository the workflow runs on.
+By default, uses the owner of the repository in which the workflow runs.
 
 ### `github_token`
 

diff --git a/action.yml b/action.yml
@@ -47,14 +47,16 @@ inputs:
       
       #### `downstream_repo`
       
-      Define if you want to backport to another repository then the workflow runs on.
+      Define if you want to backport to a repository other than where the workflow runs.
+
+      By default, the action always backports to the repository in which the workflow runs.
       
       #### `downstream_owner`
       
-      Define if you want to backport to another owner then the owner of the repository the workflow runs on.
-      
-      Only specify together with the `downstream_repo` property.
-      If undefined, uses the owner of the repository the workflow runs on.
+      Define if you want to backport to another owner than the owner of the repository the workflow runs on.
+      Only takes effect if the `downstream_repo` property is also defined.
+
+      By default, uses the owner of the repository in which the workflow runs.
     default: >
       {
         "detect_merge_method": false