From 9b9f1ae0739da88cd4221e9ad8ea575dbc74419c Mon Sep 17 00:00:00 2001 From: Nilesh Arnaiya Date: Wed, 30 Oct 2019 19:31:34 +0530 Subject: [PATCH 1/3] Update GETTING_STARTED.md --- docs/GETTING_STARTED.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/GETTING_STARTED.md b/docs/GETTING_STARTED.md index d6841c109..bd7a7690f 100644 --- a/docs/GETTING_STARTED.md +++ b/docs/GETTING_STARTED.md @@ -7,7 +7,7 @@ in the JSDoc format. **But don't worry! Even though it's embedded in your code, JSDoc is not code. It's a simple and standard syntax for writing documentation. You don't need to be a developer to use it.** -Before you continue, make sure `documentation` is on your system (do `npm install -g documentation`, if not installed). +Before you continue, make sure `documentation` is on your system (do `npm install -g documentation,` if not installed). Now, let's dive in. @@ -62,7 +62,7 @@ On the second line: * `@param` is **a tag**: This tag indicates that we'll be documenting a function's parameter. * `{number}` is **a type**. It says that the input to this function is - a JavaScript "number". It could also say `{string}`, + A JavaScript "number." It could also say `{string}`, `{Object}`, `{Date}`, or any other JavaScript built-in type. And if you defined a custom class, like `FooClass`, you can use it as a type too by saying `{FooClass}`. @@ -97,7 +97,7 @@ populates @name, @kind, and @memberof tags based on its reading of the code. **Normalization**: JSDoc has multiple words for the same thing: you can -say @augments or @extends and they'll do the same thing. +say @augments or @extends, and they'll do the same thing. ## Development Process @@ -112,7 +112,7 @@ automated style check. JSDoc syntax, and is a great reference. The most commonly used tags are: -* @param - input given to a function as an argument +* @param - input is given to a function as an argument * @returns - output value of a function * @name - explicitly set the documented name of a function, class, or variable * @private - you can use @private to document From f0dc4d9374bde333dcfa45ff921f2ff09f28d11c Mon Sep 17 00:00:00 2001 From: Tom MacWright Date: Tue, 10 Mar 2020 16:12:10 -0700 Subject: [PATCH 2/3] Update GETTING_STARTED.md --- docs/GETTING_STARTED.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/GETTING_STARTED.md b/docs/GETTING_STARTED.md index bd7a7690f..5a401fc84 100644 --- a/docs/GETTING_STARTED.md +++ b/docs/GETTING_STARTED.md @@ -7,7 +7,7 @@ in the JSDoc format. **But don't worry! Even though it's embedded in your code, JSDoc is not code. It's a simple and standard syntax for writing documentation. You don't need to be a developer to use it.** -Before you continue, make sure `documentation` is on your system (do `npm install -g documentation,` if not installed). +Before you continue, make sure `documentation` is on your system (do `npm install -g documentation`, if not installed). Now, let's dive in. From 921519c00ccb49ee29e324e093d29d5cd2c63a85 Mon Sep 17 00:00:00 2001 From: Tom MacWright Date: Mon, 16 Mar 2020 21:16:29 -0700 Subject: [PATCH 3/3] Update GETTING_STARTED.md --- docs/GETTING_STARTED.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/GETTING_STARTED.md b/docs/GETTING_STARTED.md index c67473590..1fc98ffe8 100644 --- a/docs/GETTING_STARTED.md +++ b/docs/GETTING_STARTED.md @@ -62,7 +62,7 @@ On the second line: * `@param` is **a tag**: This tag indicates that we'll be documenting a function's parameter. * `{number}` is **a type**. It says that the input to this function is - A JavaScript "number." It could also say `{string}`, + a JavaScript "number." It could also say `{string}`, `{Object}`, `{Date}`, or any other JavaScript built-in type. And if you defined a custom class, like `FooClass`, you can use it as a type, too! Just say `{FooClass}`. * `input` is the name of the input variable. It matches what the code pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy