From ffbd6a3f930d83dc67f0ccdb63f774460e005973 Mon Sep 17 00:00:00 2001 From: Remy Suen Date: Tue, 17 Jan 2017 18:25:57 +0900 Subject: [PATCH] Correct parameter documentation for tree(*) The treeish parameter claims that an Oid is valid but the underlying git_checkout_tree C api does not actually support Oid as a parameter. The JavaScript function does however take a String. Fix the documentation to replace Oid with String as a valid parameter. --- lib/checkout.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/checkout.js b/lib/checkout.js index 652f6116a..f99e27fd0 100644 --- a/lib/checkout.js +++ b/lib/checkout.js @@ -40,7 +40,7 @@ Checkout.index = function(repo, index, options) { * * @async * @param {Repository} repo -* @param {Oid|Tree|Commit|Reference} treeish +* @param {String|Tree|Commit|Reference} treeish * @param {CheckoutOptions} [options] * @return {Void} checkout complete */