Skip to content

Commit

Permalink
doc: copyedit util doc
Browse files Browse the repository at this point in the history
Add verbs to make sentence fragments less fragmentary.

PR-URL: #5399
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
  • Loading branch information
Trott authored and Myles Borins committed Mar 1, 2016
1 parent 5a618e3 commit ee17a8f
Showing 1 changed file with 20 additions and 15 deletions.
35 changes: 20 additions & 15 deletions doc/api/util.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ util.inspect(obj);

Internal alias for [`Array.isArray`][].

Returns `true` if the given "object" is an `Array`. `false` otherwise.
Returns `true` if the given "object" is an `Array`. Otherwise, returns `false`.

```js
const util = require('util');
Expand All @@ -271,7 +271,7 @@ util.isArray({})

Stability: 0 - Deprecated

Returns `true` if the given "object" is a `Boolean`. `false` otherwise.
Returns `true` if the given "object" is a `Boolean`. Otherwise, returns `false`.

```js
const util = require('util');
Expand All @@ -288,7 +288,7 @@ util.isBoolean(false)

Stability: 0 - Deprecated: Use [`Buffer.isBuffer()`][] instead.

Returns `true` if the given "object" is a `Buffer`. `false` otherwise.
Returns `true` if the given "object" is a `Buffer`. Otherwise, returns `false`.

```js
const util = require('util');
Expand All @@ -305,7 +305,7 @@ util.isBuffer(new Buffer('hello world'))

Stability: 0 - Deprecated

Returns `true` if the given "object" is a `Date`. `false` otherwise.
Returns `true` if the given "object" is a `Date`. Otherwise, returns `false`.

```js
const util = require('util');
Expand All @@ -322,7 +322,8 @@ util.isDate({})

Stability: 0 - Deprecated

Returns `true` if the given "object" is an [`Error`][]. `false` otherwise.
Returns `true` if the given "object" is an [`Error`][]. Otherwise, returns
`false`.

```js
const util = require('util');
Expand All @@ -339,7 +340,8 @@ util.isError({ name: 'Error', message: 'an error occurred' })

Stability: 0 - Deprecated

Returns `true` if the given "object" is a `Function`. `false` otherwise.
Returns `true` if the given "object" is a `Function`. Otherwise, returns
`false`.

```js
const util = require('util');
Expand All @@ -359,7 +361,8 @@ util.isFunction(Bar)

Stability: 0 - Deprecated

Returns `true` if the given "object" is strictly `null`. `false` otherwise.
Returns `true` if the given "object" is strictly `null`. Otherwise, returns
`false`.

```js
const util = require('util');
Expand All @@ -376,7 +379,8 @@ util.isNull(null)

Stability: 0 - Deprecated

Returns `true` if the given "object" is `null` or `undefined`. `false` otherwise.
Returns `true` if the given "object" is `null` or `undefined`. Otherwise,
returns `false`.

```js
const util = require('util');
Expand All @@ -393,7 +397,7 @@ util.isNullOrUndefined(null)

Stability: 0 - Deprecated

Returns `true` if the given "object" is a `Number`. `false` otherwise.
Returns `true` if the given "object" is a `Number`. Otherwise, returns `false`.

```js
const util = require('util');
Expand All @@ -413,7 +417,7 @@ util.isNumber(NaN)
Stability: 0 - Deprecated

Returns `true` if the given "object" is strictly an `Object` __and__ not a
`Function`. `false` otherwise.
`Function`. Otherwise, returns `false`.

```js
const util = require('util');
Expand All @@ -432,7 +436,8 @@ util.isObject(function(){})

Stability: 0 - Deprecated

Returns `true` if the given "object" is a primitive type. `false` otherwise.
Returns `true` if the given "object" is a primitive type. Otherwise, returns
`false`.

```js
const util = require('util');
Expand Down Expand Up @@ -461,7 +466,7 @@ util.isPrimitive(new Date())

Stability: 0 - Deprecated

Returns `true` if the given "object" is a `RegExp`. `false` otherwise.
Returns `true` if the given "object" is a `RegExp`. Otherwise, returns `false`.

```js
const util = require('util');
Expand All @@ -478,7 +483,7 @@ util.isRegExp({})

Stability: 0 - Deprecated

Returns `true` if the given "object" is a `String`. `false` otherwise.
Returns `true` if the given "object" is a `String`. Otherwise, returns `false`.

```js
const util = require('util');
Expand All @@ -497,7 +502,7 @@ util.isString(5)

Stability: 0 - Deprecated

Returns `true` if the given "object" is a `Symbol`. `false` otherwise.
Returns `true` if the given "object" is a `Symbol`. Otherwise, returns `false`.

```js
const util = require('util');
Expand All @@ -514,7 +519,7 @@ util.isSymbol(Symbol('foo'))

Stability: 0 - Deprecated

Returns `true` if the given "object" is `undefined`. `false` otherwise.
Returns `true` if the given "object" is `undefined`. Otherwise, returns `false`.

```js
const util = require('util');
Expand Down

0 comments on commit ee17a8f

Please sign in to comment.