From ceca03b20cdf713a84b4bed0d19470b8d03769dd Mon Sep 17 00:00:00 2001 From: Casper da Costa-Luis Date: Mon, 31 Oct 2022 21:34:52 +0000 Subject: [PATCH] slight docs update --- bin/cml/repo/prepare.js | 3 +-- bin/cml/repo/prepare.test.js | 4 ++-- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/bin/cml/repo/prepare.js b/bin/cml/repo/prepare.js index 19ae7a32c..82ae22a4f 100644 --- a/bin/cml/repo/prepare.js +++ b/bin/cml/repo/prepare.js @@ -22,8 +22,7 @@ exports.builder = (yargs) => exports.options = kebabcaseKeys({ fetchDepth: { type: 'number', - description: - 'Number of commits to fetch. 0 indicates all history for all branches and tags' + description: 'Number of commits to fetch (use `0` for all branches & tags)' }, unshallow: { type: 'boolean', diff --git a/bin/cml/repo/prepare.test.js b/bin/cml/repo/prepare.test.js index 71a11b095..6a765847b 100644 --- a/bin/cml/repo/prepare.test.js +++ b/bin/cml/repo/prepare.test.js @@ -20,8 +20,8 @@ describe('CML e2e', () => { --help Show help [boolean] Options: - --fetch-depth Number of commits to fetch. 0 indicates all history for all - branches and tags [number] + --fetch-depth Number of commits to fetch (use \`0\` for all branches & tags) + [number] --user-email Git user email [string] [default: \\"olivaw@iterative.ai\\"] --user-name Git user name [string] [default: \\"Olivaw[bot]\\"]" `);