Skip to content

Commit 5c7e044

Browse files
Documentation tweaks
1 parent 360199d commit 5c7e044

File tree

3 files changed

+5
-6
lines changed

3 files changed

+5
-6
lines changed

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,6 @@ Diffbot documentation: https://www.diffbot.com/dev/docs/video/
130130
### Knowledge Graph API
131131
Diffbot documentation: https://docs.diffbot.com/kgapi
132132
```javascript
133-
// Knowledge Graph
134133
let kg = await diffbot.knowledgeGraph({
135134
query: 'type:LocalBusiness location.{country.name:"Canada" city.name:"Ottawa" isCurrent:true}'
136135
});

src/diffbot.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ declare class Diffbot {
4141
* Execute an article API call
4242
* @param {Object} options The search options
4343
* @param {string} [options.url] Web page URL of the article to process (required unless posting plain text)
44-
* @param {string[]} [options.fields] Used to specify optional fields to be returned by the Article API.
44+
* @param {string[]} [options.fields] Used to specify optional fields to be returned by the Article API. See fields: https://www.diffbot.com/dev/docs/article/#fields
4545
* @param {boolean} [options.paging] Pass paging=false to disable automatic concatenation of multiple-page articles. (By default, Diffbot will concatenate up to 20 pages of a single article.)
4646
* @param {number} [options.maxTags] Set the maximum number of automatically-generated tags to return. By default a maximum of ten tags will be returned.
4747
* @param {number} [options.tagConfidence] Set the minimum relevance score of tags to return, between 0.0 and 1.0. By default only tags with a score equal to or above 0.5 will be returned.
@@ -139,7 +139,7 @@ declare class Diffbot {
139139
* Execute a product API call
140140
* @param {Object} options The search options
141141
* @param {string} options.url Web page URL of the product to process
142-
* @param {string[]} [options.fields] Used to specify optional fields to be returned by the Product API.
142+
* @param {string[]} [options.fields] Used to specify optional fields to be returned by the Product API. See fields: https://www.diffbot.com/dev/docs/product/#fields
143143
* @param {boolean} [options.discussion] Pass discussion=false to disable automatic extraction of product reviews.
144144
* @param {number} [options.timeout] Sets a value in milliseconds to wait for the retrieval/fetch of content from the requested URL. The default timeout for the third-party response is 30 seconds (30000).
145145
* @param {string} [options.callback] Use for jsonp requests. Needed for cross-domain ajax.

src/diffbot.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ class Diffbot {
4343

4444
if (options.fields)
4545
diffbot_url += `&fields=${options.fields.join(',')}`;
46-
46+
4747
// Use of `paging` for the analyze endpoint is undocumented, but does work and was recommended by Diffbot support
4848
// See: https://github.com/theRealPadster/diffbot-api-node/issues/16
4949
if (options.paging != undefined)
@@ -76,7 +76,7 @@ class Diffbot {
7676
* Execute an article API call
7777
* @param {Object} options The search options
7878
* @param {string} [options.url] Web page URL of the article to process (required unless posting plain text)
79-
* @param {string[]} [options.fields] Used to specify optional fields to be returned by the Article API.
79+
* @param {string[]} [options.fields] Used to specify optional fields to be returned by the Article API. See fields: https://www.diffbot.com/dev/docs/article/#fields
8080
* @param {boolean} [options.paging] Pass paging=false to disable automatic concatenation of multiple-page articles. (By default, Diffbot will concatenate up to 20 pages of a single article.)
8181
* @param {number} [options.maxTags] Set the maximum number of automatically-generated tags to return. By default a maximum of ten tags will be returned.
8282
* @param {number} [options.tagConfidence] Set the minimum relevance score of tags to return, between 0.0 and 1.0. By default only tags with a score equal to or above 0.5 will be returned.
@@ -276,7 +276,7 @@ class Diffbot {
276276
* Execute a product API call
277277
* @param {Object} options The search options
278278
* @param {string} options.url Web page URL of the product to process
279-
* @param {string[]} [options.fields] Used to specify optional fields to be returned by the Product API.
279+
* @param {string[]} [options.fields] Used to specify optional fields to be returned by the Product API. See fields: https://www.diffbot.com/dev/docs/product/#fields
280280
* @param {boolean} [options.discussion] Pass discussion=false to disable automatic extraction of product reviews.
281281
* @param {number} [options.timeout] Sets a value in milliseconds to wait for the retrieval/fetch of content from the requested URL. The default timeout for the third-party response is 30 seconds (30000).
282282
* @param {string} [options.callback] Use for jsonp requests. Needed for cross-domain ajax.

0 commit comments

Comments
 (0)