simon/semantic-release
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: typo in JS docs

Browse Source
This commit is contained in:
Pierre Vanduynslager 2018-11-19 18:25:14 -05:00
parent 9742712957
commit f2ede5bdde
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
lib/git.js
View File

@ -4,7 +4,7 @@ const debug = require('debug')('semantic-release:git');
/** /**
* Get the commit sha for a given tag. * Get the commit sha for a given tag.
* *
* @param {string} tagName Tag name for which to retrieve the commit sha. * @param {String} tagName Tag name for which to retrieve the commit sha.
* @param {Object} [execaOpts] Options to pass to `execa`. * @param {Object} [execaOpts] Options to pass to `execa`.
* *
* @return {string} The commit sha of the tag in parameter or `null`. * @return {string} The commit sha of the tag in parameter or `null`.
@ -35,10 +35,10 @@ async function getTags(execaOpts) {
/** /**
* Verify if the `ref` is in the direct history of the current branch. * Verify if the `ref` is in the direct history of the current branch.
* *
* @param {string} ref The reference to look for. * @param {String} ref The reference to look for.
* @param {Object} [execaOpts] Options to pass to `execa`. * @param {Object} [execaOpts] Options to pass to `execa`.
* *
* @return {boolean} `true` if the reference is in the history of the current branch, falsy otherwise. * @return {Boolean} `true` if the reference is in the history of the current branch, falsy otherwise.
*/ */
async function isRefInHistory(ref, execaOpts) { async function isRefInHistory(ref, execaOpts) {
try { try {
@ -73,7 +73,7 @@ async function fetch(repositoryUrl, execaOpts) {
* *
* @param {Object} [execaOpts] Options to pass to `execa`. * @param {Object} [execaOpts] Options to pass to `execa`.
* *
* @return {string} the sha of the HEAD commit. * @return {String} the sha of the HEAD commit.
*/ */
function getGitHead(execaOpts) { function getGitHead(execaOpts) {
return execa.stdout('git', ['rev-parse', 'HEAD'], execaOpts); return execa.stdout('git', ['rev-parse', 'HEAD'], execaOpts);
@ -155,10 +155,10 @@ async function push(repositoryUrl, branch, execaOpts) {
/** /**
* Verify a tag name is a valid Git reference. * Verify a tag name is a valid Git reference.
* *
* @param {string} tagName the tag name to verify. * @param {String} tagName the tag name to verify.
* @param {Object} [execaOpts] Options to pass to `execa`. * @param {Object} [execaOpts] Options to pass to `execa`.
* *
* @return {boolean} `true` if valid, falsy otherwise. * @return {Boolean} `true` if valid, falsy otherwise.
*/ */
async function verifyTagName(tagName, execaOpts) { async function verifyTagName(tagName, execaOpts) {
try { try {