Skip to content

Commit

Permalink
doc: apply consistent styling for functions
Browse files Browse the repository at this point in the history
Always refer to (for example) `assert.deepEqual()` as
`assert.deepEqual()` and never as `assert.deepEqual`.

PR-URL: #4974
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
  • Loading branch information
Trott authored and Myles Borins committed Feb 22, 2016
1 parent fb63d96 commit 36c0ce0
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions doc/api/assert.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ parameter is undefined, a default error message is assigned.

## assert.deepStrictEqual(actual, expected[, message])

Generally identical to `assert.deepEqual` with the exception that primitive
Generally identical to [`assert.deepEqual()`][] with the exception that primitive
values are compared using the strict equality operator ( `===` ).

```js
Expand Down Expand Up @@ -214,7 +214,7 @@ assert.ifError(new Error()); // Throws Error

## assert.notDeepEqual(actual, expected[, message])

Tests for any deep inequality. Opposite of [`assert.deepEqual`][].
Tests for any deep inequality. Opposite of [`assert.deepEqual()`][].

```js
const assert = require('assert');
Expand Down Expand Up @@ -255,7 +255,7 @@ parameter is undefined, a default error message is assigned.

## assert.notDeepStrictEqual(actual, expected[, message])

Tests for deep strict inequality. Opposite of [`assert.deepStrictEqual`][].
Tests for deep strict inequality. Opposite of [`assert.deepStrictEqual()`][].

```js
const assert = require('assert');
Expand Down Expand Up @@ -402,8 +402,8 @@ assert.throws(
```

[Locked]: documentation.html#documentation_stability_index
[`assert.deepEqual`]: #assert_assert_deepequal_actual_expected_message
[`assert.deepStrictEqual`]: #assert_assert_deepstrictequal_actual_expected_message
[`assert.deepEqual()`]: #assert_assert_deepequal_actual_expected_message
[`assert.deepStrictEqual()`]: #assert_assert_deepstrictequal_actual_expected_message
[`assert.ok()`]: #assert_assert_ok_value_message
[`assert.throws()`]: #assert_assert_throws_block_error_message
[`Error`]: errors.html#errors_class_error
Expand Down

0 comments on commit 36c0ce0

Please sign in to comment.