Update description (actions#65)

chouetz · Dec 5, 2019 · 7990b10 · 7990b10
1 parent 01a4343
commit 7990b10
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -38,8 +38,9 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous
     # Default: ${{ github.repository }}
     repository: ''
 
-    # Ref to checkout (SHA, branch, tag). For the repository that triggered the
-    # workflow, defaults to the ref/SHA for the event. Otherwise defaults to master.
+    # The branch, tag or SHA to checkout.  When checking out the repository that
+    # triggered a workflow, this defaults to the reference or SHA for that event.
+    # Otherwise, defaults to `master`.
     ref: ''
 
     # Access token for clone repository

diff --git a/action.yml b/action.yml
@@ -1,13 +1,14 @@
 name: 'Checkout'
-description: 'Checkout a Git repository'
+description: 'Checkout a Git repository at a particular version'
 inputs: 
   repository:
     description: 'Repository name with owner. For example, actions/checkout'
     default: ${{ github.repository }}
   ref:
     description: >
-      Ref to checkout (SHA, branch, tag). For the repository that triggered the
-      workflow, defaults to the ref/SHA for the event. Otherwise defaults to master.
+      The branch, tag or SHA to checkout.  When checking out the repository
+      that triggered a workflow, this defaults to the reference or SHA for
+      that event.  Otherwise, defaults to `master`.
   token:
     description: 'Access token for clone repository'
     default: ${{ github.token }}
@@ -25,4 +26,4 @@ inputs:
 runs:
   using: node12
   main: dist/index.js
-  post: dist/index.js
+  post: dist/index.js