From 6c766b7785436fd7917647b86bbd8c573a5deab1 Mon Sep 17 00:00:00 2001 From: John Lin Date: Mon, 16 Dec 2019 12:21:59 +0800 Subject: [PATCH] Describe the naming for the function it() When I first saw it(), I was wondering if the name "it" is an abbreviation of anything. After some search, I finally realized that the name is only a pronoun. Therefore, I think it's worthwhile to include it in the documentation. --- src/core/requireInterface.js | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/core/requireInterface.js b/src/core/requireInterface.js index f8f15ac6..012f7303 100644 --- a/src/core/requireInterface.js +++ b/src/core/requireInterface.js @@ -60,6 +60,9 @@ getJasmineRequireObj().interface = function(jasmine, env) { * Define a single spec. A spec should contain one or more {@link expect|expectations} that test the state of the code. * * A spec whose expectations all succeed will be passing and a spec with any failures will fail. + * The name `it` is a pronoun for the test target, not an abbreviation of anything. It makes the + * spec more readable by connecting the function name `it` and the argument `description` as a + * complete sentence. * @name it * @since 1.3.0 * @function