From 64f2120674fe9b82318862dd7f9b1ebd7009f715 Mon Sep 17 00:00:00 2001 From: Lloyd Brookes Date: Wed, 17 Jan 2018 15:30:58 +0000 Subject: [PATCH] docs --- README.md | 2 +- doc/option-definition.md | 2 +- lib/option-definition.js | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5a8ecb2..c9ca43c 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ $ example -vt 1000 --src one.js two.js $ example -vt 1000 one.js two.js ``` -To access the values, first create a list of [option definitions](https://github.com/75lb/command-line-args/blob/next/doc/option-definition.md) describing your accepted options. The [`type`](https://github.com/75lb/command-line-args/blob/next/doc/option-definition.md#optiontype--function) property is a setter function (the value supplied is passed through this), giving you full control over the value received. +To access the values, first create a list of [option definitions](https://github.com/75lb/command-line-args/blob/next/doc/option-definition.md) describing the options your application accepts. The [`type`](https://github.com/75lb/command-line-args/blob/next/doc/option-definition.md#optiontype--function) property is a setter function (the value supplied is passed through this), giving you full control over the value received. ```js const optionDefinitions = [ diff --git a/doc/option-definition.md b/doc/option-definition.md index 4e87ec2..6f81155 100644 --- a/doc/option-definition.md +++ b/doc/option-definition.md @@ -53,7 +53,7 @@ const optionDefinitions = [ #### option.type : function The `type` value is a setter function (you receive the output from this), enabling you to be specific about the type and value received. -The most common values used are `String`, `Number` and `Boolean` but you can use a custom function, if you like: +The most common values used are `String`, `Number` and `Boolean` but you can use a custom function, for example: ```js const fs = require('fs') diff --git a/lib/option-definition.js b/lib/option-definition.js index 0403c7c..253cbbf 100644 --- a/lib/option-definition.js +++ b/lib/option-definition.js @@ -45,7 +45,7 @@ class OptionDefinition { /** * The `type` value is a setter function (you receive the output from this), enabling you to be specific about the type and value received. * - * The most common values used are `String`, `Number` and `Boolean` but you can use a custom function, if you like: + * The most common values used are `String`, `Number` and `Boolean` but you can use a custom function, for example: * * ```js * const fs = require('fs')