Skip to content

Commit 8ed321a

Browse files
jkwluiJustinBeckwith
jkwlui
authored and
JustinBeckwith
committed
fix(docs): properly show how to require this module (#263)
1 parent afd2620 commit 8ed321a

16 files changed

+100
-100
lines changed

‎packages/google-cloud-dialogflow/src/index.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,14 +78,14 @@ const gapic = Object.freeze({
7878
* - `SessionsClient` - Reference to
7979
* {@link v2.SessionsClient}
8080
*
81-
* @module {object} dialogflow
81+
* @module {object} @google-cloud/dialogflow
8282
* @alias nodejs-dialogflow
8383
*
8484
* @example <caption>Install the client library with <a href="https://www.npmjs.com/">npm</a>:</caption>
85-
* npm install --save dialogflow
85+
* npm install --save @google-cloud/dialogflow
8686
*
8787
* @example <caption>Import the client library:</caption>
88-
* const dialogflow = require('dialogflow');
88+
* const dialogflow = require('@google-cloud/dialogflow');
8989
*
9090
* @example <caption>Create a client that uses <a href="https://goo.gl/64dyYX">Application Default Credentials (ADC)</a>:</caption>
9191
* const client = new dialogflow.AgentsClient();

‎packages/google-cloud-dialogflow/src/v2/agents_client.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ class AgentsClient {
296296
*
297297
* @example
298298
*
299-
* const dialogflow = require('dialogflow.v2');
299+
* const dialogflow = require('@google-cloud/dialogflow');
300300
*
301301
* const client = new dialogflow.v2.AgentsClient({
302302
* // optional auth parameters.
@@ -367,7 +367,7 @@ class AgentsClient {
367367
*
368368
* @example
369369
*
370-
* const dialogflow = require('dialogflow.v2');
370+
* const dialogflow = require('@google-cloud/dialogflow');
371371
*
372372
* const client = new dialogflow.v2.AgentsClient({
373373
* // optional auth parameters.
@@ -455,7 +455,7 @@ class AgentsClient {
455455
*
456456
* @example
457457
*
458-
* const dialogflow = require('dialogflow.v2');
458+
* const dialogflow = require('@google-cloud/dialogflow');
459459
*
460460
* const client = new dialogflow.v2.AgentsClient({
461461
* // optional auth parameters.
@@ -503,7 +503,7 @@ class AgentsClient {
503503
*
504504
* @example
505505
*
506-
* const dialogflow = require('dialogflow.v2');
506+
* const dialogflow = require('@google-cloud/dialogflow');
507507
*
508508
* const client = new dialogflow.v2.AgentsClient({
509509
* // optional auth parameters.
@@ -601,7 +601,7 @@ class AgentsClient {
601601
*
602602
* @example
603603
*
604-
* const dialogflow = require('dialogflow.v2');
604+
* const dialogflow = require('@google-cloud/dialogflow');
605605
*
606606
* const client = new dialogflow.v2.AgentsClient({
607607
* // optional auth parameters.
@@ -717,7 +717,7 @@ class AgentsClient {
717717
*
718718
* @example
719719
*
720-
* const dialogflow = require('dialogflow.v2');
720+
* const dialogflow = require('@google-cloud/dialogflow');
721721
*
722722
* const client = new dialogflow.v2.AgentsClient({
723723
* // optional auth parameters.
@@ -832,7 +832,7 @@ class AgentsClient {
832832
*
833833
* @example
834834
*
835-
* const dialogflow = require('dialogflow.v2');
835+
* const dialogflow = require('@google-cloud/dialogflow');
836836
*
837837
* const client = new dialogflow.v2.AgentsClient({
838838
* // optional auth parameters.

‎packages/google-cloud-dialogflow/src/v2/contexts_client.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ class ContextsClient {
254254
*
255255
* @example
256256
*
257-
* const dialogflow = require('dialogflow.v2');
257+
* const dialogflow = require('@google-cloud/dialogflow');
258258
*
259259
* const client = new dialogflow.v2.ContextsClient({
260260
* // optional auth parameters.
@@ -342,7 +342,7 @@ class ContextsClient {
342342
*
343343
* @example
344344
*
345-
* const dialogflow = require('dialogflow.v2');
345+
* const dialogflow = require('@google-cloud/dialogflow');
346346
*
347347
* const client = new dialogflow.v2.ContextsClient({
348348
* // optional auth parameters.
@@ -387,7 +387,7 @@ class ContextsClient {
387387
*
388388
* @example
389389
*
390-
* const dialogflow = require('dialogflow.v2');
390+
* const dialogflow = require('@google-cloud/dialogflow');
391391
*
392392
* const client = new dialogflow.v2.ContextsClient({
393393
* // optional auth parameters.
@@ -438,7 +438,7 @@ class ContextsClient {
438438
*
439439
* @example
440440
*
441-
* const dialogflow = require('dialogflow.v2');
441+
* const dialogflow = require('@google-cloud/dialogflow');
442442
*
443443
* const client = new dialogflow.v2.ContextsClient({
444444
* // optional auth parameters.
@@ -495,7 +495,7 @@ class ContextsClient {
495495
*
496496
* @example
497497
*
498-
* const dialogflow = require('dialogflow.v2');
498+
* const dialogflow = require('@google-cloud/dialogflow');
499499
*
500500
* const client = new dialogflow.v2.ContextsClient({
501501
* // optional auth parameters.
@@ -539,7 +539,7 @@ class ContextsClient {
539539
*
540540
* @example
541541
*
542-
* const dialogflow = require('dialogflow.v2');
542+
* const dialogflow = require('@google-cloud/dialogflow');
543543
*
544544
* const client = new dialogflow.v2.ContextsClient({
545545
* // optional auth parameters.
@@ -578,7 +578,7 @@ class ContextsClient {
578578
*
579579
* @example
580580
*
581-
* const dialogflow = require('dialogflow.v2');
581+
* const dialogflow = require('@google-cloud/dialogflow');
582582
*
583583
* const client = new dialogflow.v2.ContextsClient({
584584
* // optional auth parameters.

‎packages/google-cloud-dialogflow/src/v2/entity_types_client.js

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -362,7 +362,7 @@ class EntityTypesClient {
362362
*
363363
* @example
364364
*
365-
* const dialogflow = require('dialogflow.v2');
365+
* const dialogflow = require('@google-cloud/dialogflow');
366366
*
367367
* const client = new dialogflow.v2.EntityTypesClient({
368368
* // optional auth parameters.
@@ -456,7 +456,7 @@ class EntityTypesClient {
456456
*
457457
* @example
458458
*
459-
* const dialogflow = require('dialogflow.v2');
459+
* const dialogflow = require('@google-cloud/dialogflow');
460460
*
461461
* const client = new dialogflow.v2.EntityTypesClient({
462462
* // optional auth parameters.
@@ -507,7 +507,7 @@ class EntityTypesClient {
507507
*
508508
* @example
509509
*
510-
* const dialogflow = require('dialogflow.v2');
510+
* const dialogflow = require('@google-cloud/dialogflow');
511511
*
512512
* const client = new dialogflow.v2.EntityTypesClient({
513513
* // optional auth parameters.
@@ -564,7 +564,7 @@ class EntityTypesClient {
564564
*
565565
* @example
566566
*
567-
* const dialogflow = require('dialogflow.v2');
567+
* const dialogflow = require('@google-cloud/dialogflow');
568568
*
569569
* const client = new dialogflow.v2.EntityTypesClient({
570570
* // optional auth parameters.
@@ -628,7 +628,7 @@ class EntityTypesClient {
628628
*
629629
* @example
630630
*
631-
* const dialogflow = require('dialogflow.v2');
631+
* const dialogflow = require('@google-cloud/dialogflow');
632632
*
633633
* const client = new dialogflow.v2.EntityTypesClient({
634634
* // optional auth parameters.
@@ -672,7 +672,7 @@ class EntityTypesClient {
672672
*
673673
* @example
674674
*
675-
* const dialogflow = require('dialogflow.v2');
675+
* const dialogflow = require('@google-cloud/dialogflow');
676676
*
677677
* const client = new dialogflow.v2.EntityTypesClient({
678678
* // optional auth parameters.
@@ -736,7 +736,7 @@ class EntityTypesClient {
736736
*
737737
* @example
738738
*
739-
* const dialogflow = require('dialogflow.v2');
739+
* const dialogflow = require('@google-cloud/dialogflow');
740740
*
741741
* const client = new dialogflow.v2.EntityTypesClient({
742742
* // optional auth parameters.
@@ -837,7 +837,7 @@ class EntityTypesClient {
837837
*
838838
* @example
839839
*
840-
* const dialogflow = require('dialogflow.v2');
840+
* const dialogflow = require('@google-cloud/dialogflow');
841841
*
842842
* const client = new dialogflow.v2.EntityTypesClient({
843843
* // optional auth parameters.
@@ -955,7 +955,7 @@ class EntityTypesClient {
955955
*
956956
* @example
957957
*
958-
* const dialogflow = require('dialogflow.v2');
958+
* const dialogflow = require('@google-cloud/dialogflow');
959959
*
960960
* const client = new dialogflow.v2.EntityTypesClient({
961961
* // optional auth parameters.
@@ -1074,7 +1074,7 @@ class EntityTypesClient {
10741074
*
10751075
* @example
10761076
*
1077-
* const dialogflow = require('dialogflow.v2');
1077+
* const dialogflow = require('@google-cloud/dialogflow');
10781078
*
10791079
* const client = new dialogflow.v2.EntityTypesClient({
10801080
* // optional auth parameters.
@@ -1188,7 +1188,7 @@ class EntityTypesClient {
11881188
*
11891189
* @example
11901190
*
1191-
* const dialogflow = require('dialogflow.v2');
1191+
* const dialogflow = require('@google-cloud/dialogflow');
11921192
*
11931193
* const client = new dialogflow.v2.EntityTypesClient({
11941194
* // optional auth parameters.

‎packages/google-cloud-dialogflow/src/v2/intents_client.js

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -329,7 +329,7 @@ class IntentsClient {
329329
*
330330
* @example
331331
*
332-
* const dialogflow = require('dialogflow.v2');
332+
* const dialogflow = require('@google-cloud/dialogflow');
333333
*
334334
* const client = new dialogflow.v2.IntentsClient({
335335
* // optional auth parameters.
@@ -427,7 +427,7 @@ class IntentsClient {
427427
*
428428
* @example
429429
*
430-
* const dialogflow = require('dialogflow.v2');
430+
* const dialogflow = require('@google-cloud/dialogflow');
431431
*
432432
* const client = new dialogflow.v2.IntentsClient({
433433
* // optional auth parameters.
@@ -482,7 +482,7 @@ class IntentsClient {
482482
*
483483
* @example
484484
*
485-
* const dialogflow = require('dialogflow.v2');
485+
* const dialogflow = require('@google-cloud/dialogflow');
486486
*
487487
* const client = new dialogflow.v2.IntentsClient({
488488
* // optional auth parameters.
@@ -543,7 +543,7 @@ class IntentsClient {
543543
*
544544
* @example
545545
*
546-
* const dialogflow = require('dialogflow.v2');
546+
* const dialogflow = require('@google-cloud/dialogflow');
547547
*
548548
* const client = new dialogflow.v2.IntentsClient({
549549
* // optional auth parameters.
@@ -611,7 +611,7 @@ class IntentsClient {
611611
*
612612
* @example
613613
*
614-
* const dialogflow = require('dialogflow.v2');
614+
* const dialogflow = require('@google-cloud/dialogflow');
615615
*
616616
* const client = new dialogflow.v2.IntentsClient({
617617
* // optional auth parameters.
@@ -660,7 +660,7 @@ class IntentsClient {
660660
*
661661
* @example
662662
*
663-
* const dialogflow = require('dialogflow.v2');
663+
* const dialogflow = require('@google-cloud/dialogflow');
664664
*
665665
* const client = new dialogflow.v2.IntentsClient({
666666
* // optional auth parameters.
@@ -726,7 +726,7 @@ class IntentsClient {
726726
*
727727
* @example
728728
*
729-
* const dialogflow = require('dialogflow.v2');
729+
* const dialogflow = require('@google-cloud/dialogflow');
730730
*
731731
* const client = new dialogflow.v2.IntentsClient({
732732
* // optional auth parameters.
@@ -834,7 +834,7 @@ class IntentsClient {
834834
*
835835
* @example
836836
*
837-
* const dialogflow = require('dialogflow.v2');
837+
* const dialogflow = require('@google-cloud/dialogflow');
838838
*
839839
* const client = new dialogflow.v2.IntentsClient({
840840
* // optional auth parameters.

‎packages/google-cloud-dialogflow/src/v2/session_entity_types_client.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ class SessionEntityTypesClient {
248248
*
249249
* @example
250250
*
251-
* const dialogflow = require('dialogflow.v2');
251+
* const dialogflow = require('@google-cloud/dialogflow');
252252
*
253253
* const client = new dialogflow.v2.SessionEntityTypesClient({
254254
* // optional auth parameters.
@@ -340,7 +340,7 @@ class SessionEntityTypesClient {
340340
*
341341
* @example
342342
*
343-
* const dialogflow = require('dialogflow.v2');
343+
* const dialogflow = require('@google-cloud/dialogflow');
344344
*
345345
* const client = new dialogflow.v2.SessionEntityTypesClient({
346346
* // optional auth parameters.
@@ -386,7 +386,7 @@ class SessionEntityTypesClient {
386386
*
387387
* @example
388388
*
389-
* const dialogflow = require('dialogflow.v2');
389+
* const dialogflow = require('@google-cloud/dialogflow');
390390
*
391391
* const client = new dialogflow.v2.SessionEntityTypesClient({
392392
* // optional auth parameters.
@@ -437,7 +437,7 @@ class SessionEntityTypesClient {
437437
*
438438
* @example
439439
*
440-
* const dialogflow = require('dialogflow.v2');
440+
* const dialogflow = require('@google-cloud/dialogflow');
441441
*
442442
* const client = new dialogflow.v2.SessionEntityTypesClient({
443443
* // optional auth parameters.
@@ -500,7 +500,7 @@ class SessionEntityTypesClient {
500500
*
501501
* @example
502502
*
503-
* const dialogflow = require('dialogflow.v2');
503+
* const dialogflow = require('@google-cloud/dialogflow');
504504
*
505505
* const client = new dialogflow.v2.SessionEntityTypesClient({
506506
* // optional auth parameters.
@@ -549,7 +549,7 @@ class SessionEntityTypesClient {
549549
*
550550
* @example
551551
*
552-
* const dialogflow = require('dialogflow.v2');
552+
* const dialogflow = require('@google-cloud/dialogflow');
553553
*
554554
* const client = new dialogflow.v2.SessionEntityTypesClient({
555555
* // optional auth parameters.

‎packages/google-cloud-dialogflow/src/v2/sessions_client.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ class SessionsClient {
235235
*
236236
* @example
237237
*
238-
* const dialogflow = require('dialogflow.v2');
238+
* const dialogflow = require('@google-cloud/dialogflow');
239239
*
240240
* const client = new dialogflow.v2.SessionsClient({
241241
* // optional auth parameters.
@@ -281,7 +281,7 @@ class SessionsClient {
281281
*
282282
* @example
283283
*
284-
* const dialogflow = require('dialogflow.v2');
284+
* const dialogflow = require('@google-cloud/dialogflow');
285285
*
286286
* const client = new dialogflow.v2.SessionsClient({
287287
* // optional auth parameters.

0 commit comments

Comments
 (0)