Skip to content

Commit 6b96936

Browse files
committed
Apply suggestions from code review
1 parent 977e05c commit 6b96936

File tree

1 file changed

+7
-7
lines changed
  • src/connections/sources/catalog/libraries/website/javascript

1 file changed

+7
-7
lines changed

src/connections/sources/catalog/libraries/website/javascript/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Field | | Type | Description
7676
`userId` | optional | String | The database ID for the user. If you don't know who the user is yet, you can omit the `userId` and just record `traits`. You can read more about identities in the [identify reference](/docs/connections/spec/identify).
7777
`traits` | optional | Object | A dictionary of traits you know about the user, like `email` or `name`. You can read more about traits in the [identify reference](/docs/connections/spec/identify/).
7878
`options` | optional | Object | A dictionary of options. For example, [enable or disable specific destinations](#managing-data-flow-with-the-integrations-object) for the call. _Note: If you do not pass a `traits` object, pass an empty object (as an '{}') before `options`._
79-
`callback` | optional | Function | A function executed after a short timeout (300 ms), giving the browser time to make outbound requests first.
79+
`callback` | optional | Function | A function executed after a timeout of 300 ms, giving the browser time to make outbound requests first.
8080

8181
By default, Analytics.js caches traits in the browser's `localStorage` and attaches them to each Identify call.
8282

@@ -126,7 +126,7 @@ Field | | Type | Description
126126
`event`| | String | The name of the event you're tracking. You can read more about the [track method](/docs/connections/spec/track) and recommended event names.
127127
`properties` | optional | Object | A dictionary of [properties](/docs/connections/spec/track#properties) for the event. If the event was `'Added to Cart'`, it might have properties like `price` and `productType`.
128128
`options` | optional | Object | A dictionary of options. For example, [enable or disable specific destinations](#managing-data-flow-with-the-integrations-object) for the call. _Note: If you do not pass a `properties` object, pass an empty object (like '{}') before `options`_.
129-
`callback` | optional | Function | A function that runs after a short timeout (300 ms), giving the browser time to make outbound requests first.
129+
`callback` | optional | Function | A function that runs after a timeout of 300 ms, giving the browser time to make outbound requests first.
130130

131131
The only required argument in Analytics.js is an _event name string_. You can read more about [how Segment recommends you name events](/docs/connections/spec/track#event).
132132

@@ -147,7 +147,7 @@ The only required argument on Track calls in Analytics.js is an `event` name str
147147
#### Track Link
148148

149149
`trackLink` is a helper method that attaches the `track` call as a handler to a link.
150-
With `trackLink`, Analytics.js inserts a short timeout (300 ms) to give the `track` call more time. This is useful when a page would redirect before the `track` method could complete all requests.
150+
With `trackLink`, Analytics.js inserts a timeout of 300 ms to give the `track` call more time. This is useful when a page would redirect before the `track` method could complete all requests.
151151

152152
The `trackLink` method follows the format below.
153153

@@ -174,7 +174,7 @@ analytics.trackLink(link, 'Clicked Free-Trial Link', {
174174
#### Track Form
175175

176176
`trackForm` is a helper method that binds a `track` call to a form submission.
177-
The `trackForm` method inserts a short timeout (300 ms) to give the `track` call more time to complete. This is useful to prevent a page from redirecting before the `track` method could complete all requests.
177+
The `trackForm` method inserts a timeout of 300 ms to give the `track` call more time to complete. This is useful to prevent a page from redirecting before the `track` method could complete all requests.
178178

179179
The `trackForm` method follows the format below.
180180

@@ -222,7 +222,7 @@ Field | | Type | Description
222222
`name` | optional | String | The name of the page.
223223
`properties` | optional | Object | A dictionary of properties of the page. Note: Analytics.js collects `url`, `title`, `referrer` and `path` are automatically. This defaults to a `canonical url`, if available, and falls back to `document.location.href`.
224224
`options` | optional | Object | A dictionary of options. For example, [enable or disable specific destinations](#managing-data-flow-with-the-integrations-object) for the call. _Note: If you do not pass a `properties` object, pass an empty object (like '{}') before `options`_.
225-
`callback` | optional | Function | A function that runs after a short timeout (300 ms), giving the browser time to make outbound requests first.
225+
`callback` | optional | Function | A function that runs after a timeout of 300 ms, giving the browser time to make outbound requests first.
226226

227227
#### Default Page Properties
228228

@@ -281,7 +281,7 @@ Field | | Type | Description
281281
`groupId` | | String | The Group ID to associate with the current user.
282282
`traits` | optional | Object | A dictionary of [traits](/docs/connections/spec/group#traits) for the group. Example traits for a group include `address`, `website`, and `employees`.
283283
`options` | optional | Object | A dictionary of options. For example, [enable or disable specific destinations](#managing-data-flow-with-the-integrations-object) for the call. _Note: If you do not pass a `properties` object, pass an empty object (like '{}') before `options`_.
284-
`callback` | optional | Function | A function that runs after a short timeout (300 ms), giving the browser time to make outbound requests first.
284+
`callback` | optional | Function | A function that runs after a timeout of 300 ms, giving the browser time to make outbound requests first.
285285

286286
Example `group` call:
287287

@@ -317,7 +317,7 @@ Field | | Type | Description
317317
`userId` | | String | The new user ID you want to associate with the user.
318318
`previousId` | optional | String | The previous ID that the user was recognized by. This defaults to the currently identified user's ID.
319319
`options` | optional | Object | A dictionary of options. For example, [enable or disable specific destinations](#managing-data-flow-with-the-integrations-object) for the call.
320-
`callback` | optional | Function | A function that is executed after a short timeout (300 ms), giving the browser time to make outbound requests first.
320+
`callback` | optional | Function | A function that is executed after a timeout of 300 ms, giving the browser time to make outbound requests first.
321321

322322
For more details about Alias, including the **`alias` call payload**, check out the [Segment Spec](/docs/connections/spec/alias/).
323323

0 commit comments

Comments
 (0)