From 2e0f606a41de8e547d694e2dc6f95a30f55fa09d Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Sat, 30 Jan 2016 11:12:55 -0800 Subject: [PATCH 1/2] doc: apply consistent styling for functions Always refer to (for example) `assert.deepEqual()` as `assert.deepEqual()` and never as `assert.deepEqual`. --- doc/api/assert.markdown | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/api/assert.markdown b/doc/api/assert.markdown index 1750aed0e1d4d2..894cc22863dba9 100644 --- a/doc/api/assert.markdown +++ b/doc/api/assert.markdown @@ -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 @@ -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'); @@ -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'); @@ -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 From e29536e5d6ab54b2f5e190f7a3989e87dd8ff264 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Tue, 2 Feb 2016 12:40:31 -0800 Subject: [PATCH 2/2] fixup per benjamingr --- doc/api/assert.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/assert.markdown b/doc/api/assert.markdown index 894cc22863dba9..23727efb0e9dde 100644 --- a/doc/api/assert.markdown +++ b/doc/api/assert.markdown @@ -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