From d8855e44760fa401393c44dba1dbb5a91c2c0e11 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Sun, 26 Aug 2018 18:20:05 -0700 Subject: [PATCH] doc: clarify ERR_AMBIGUOUS_ARGUMENT PR-URL: https://github.com/nodejs/node/pull/22542 Reviewed-By: Ruben Bridgewater Reviewed-By: Vse Mozhet Byt Reviewed-By: Luigi Pinca --- doc/api/errors.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/doc/api/errors.md b/doc/api/errors.md index f34b53e0110..4757496fa6a 100644 --- a/doc/api/errors.md +++ b/doc/api/errors.md @@ -581,10 +581,12 @@ found [here][online]. ### ERR_AMBIGUOUS_ARGUMENT -This is triggered by the `assert` module in case e.g., -`assert.throws(fn, message)` is used in a way that the message is the thrown -error message. This is ambiguous because the message is not verifying the error -message and will only be thrown in case no error is thrown. +A function argument is being used in a way that suggests that the function +signature may be misunderstood. This is thrown by the `assert` module when the +`message` parameter in `assert.throws(block, message)` matches the error message +thrown by `block` because that usage suggests that the user believes `message` +is the expected message rather than the message the `AssertionError` will +display if `block` does not throw. ### ERR_ARG_NOT_ITERABLE