Commit ffbd6a3
committed
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.1 parent de3583b commit ffbd6a3
1 file changed
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -40,7 +40,7 @@ Checkout.index = function(repo, index, options) { | |||
| 40 | 40 | * | |
| 41 | 41 | * @async | |
| 42 | 42 | * @param {Repository} repo | |
| 43 | - * @param {Oid|Tree|Commit|Reference} treeish | ||
| 43 | + * @param {String|Tree|Commit|Reference} treeish | ||
| 44 | 44 | * @param {CheckoutOptions} [options] | |
| 45 | 45 | * @return {Void} checkout complete | |
| 46 | 46 | */ | |
0 commit comments