fix(docs): properly show how to require this module (#263)

googleapis · Jan 28, 2019 · 8ed321a · 8ed321a
1 parent afd2620
commit 8ed321a
Show file tree

Hide file tree

Showing 16 changed files with 100 additions and 100 deletions.
diff --git a/packages/google-cloud-dialogflow/src/index.js b/packages/google-cloud-dialogflow/src/index.js
@@ -78,14 +78,14 @@ const gapic = Object.freeze({
  *     - `SessionsClient` - Reference to
  *       {@link v2.SessionsClient}
  *
- * @module {object} dialogflow
+ * @module {object} @google-cloud/dialogflow
  * @alias nodejs-dialogflow
  *
  * @example <caption>Install the client library with <a href="https://www.npmjs.com/">npm</a>:</caption>
- * npm install --save dialogflow
+ * npm install --save @google-cloud/dialogflow
  *
  * @example <caption>Import the client library:</caption>
- * const dialogflow = require('dialogflow');
+ * const dialogflow = require('@google-cloud/dialogflow');
  *
  * @example <caption>Create a client that uses <a href="https://goo.gl/64dyYX">Application Default Credentials (ADC)</a>:</caption>
  * const client = new dialogflow.AgentsClient();

diff --git a/packages/google-cloud-dialogflow/src/v2/agents_client.js b/packages/google-cloud-dialogflow/src/v2/agents_client.js
@@ -296,7 +296,7 @@ class AgentsClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.AgentsClient({
    *   // optional auth parameters.
@@ -367,7 +367,7 @@ class AgentsClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.AgentsClient({
    *   // optional auth parameters.
@@ -455,7 +455,7 @@ class AgentsClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.AgentsClient({
    *   // optional auth parameters.
@@ -503,7 +503,7 @@ class AgentsClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.AgentsClient({
    *   // optional auth parameters.
@@ -601,7 +601,7 @@ class AgentsClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.AgentsClient({
    *   // optional auth parameters.
@@ -717,7 +717,7 @@ class AgentsClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.AgentsClient({
    *   // optional auth parameters.
@@ -832,7 +832,7 @@ class AgentsClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.AgentsClient({
    *   // optional auth parameters.

diff --git a/packages/google-cloud-dialogflow/src/v2/contexts_client.js b/packages/google-cloud-dialogflow/src/v2/contexts_client.js
@@ -254,7 +254,7 @@ class ContextsClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.ContextsClient({
    *   // optional auth parameters.
@@ -342,7 +342,7 @@ class ContextsClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.ContextsClient({
    *   // optional auth parameters.
@@ -387,7 +387,7 @@ class ContextsClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.ContextsClient({
    *   // optional auth parameters.
@@ -438,7 +438,7 @@ class ContextsClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.ContextsClient({
    *   // optional auth parameters.
@@ -495,7 +495,7 @@ class ContextsClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.ContextsClient({
    *   // optional auth parameters.
@@ -539,7 +539,7 @@ class ContextsClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.ContextsClient({
    *   // optional auth parameters.
@@ -578,7 +578,7 @@ class ContextsClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.ContextsClient({
    *   // optional auth parameters.

diff --git a/packages/google-cloud-dialogflow/src/v2/entity_types_client.js b/packages/google-cloud-dialogflow/src/v2/entity_types_client.js
@@ -362,7 +362,7 @@ class EntityTypesClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.EntityTypesClient({
    *   // optional auth parameters.
@@ -456,7 +456,7 @@ class EntityTypesClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.EntityTypesClient({
    *   // optional auth parameters.
@@ -507,7 +507,7 @@ class EntityTypesClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.EntityTypesClient({
    *   // optional auth parameters.
@@ -564,7 +564,7 @@ class EntityTypesClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.EntityTypesClient({
    *   // optional auth parameters.
@@ -628,7 +628,7 @@ class EntityTypesClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.EntityTypesClient({
    *   // optional auth parameters.
@@ -672,7 +672,7 @@ class EntityTypesClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.EntityTypesClient({
    *   // optional auth parameters.
@@ -736,7 +736,7 @@ class EntityTypesClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.EntityTypesClient({
    *   // optional auth parameters.
@@ -837,7 +837,7 @@ class EntityTypesClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.EntityTypesClient({
    *   // optional auth parameters.
@@ -955,7 +955,7 @@ class EntityTypesClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.EntityTypesClient({
    *   // optional auth parameters.
@@ -1074,7 +1074,7 @@ class EntityTypesClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.EntityTypesClient({
    *   // optional auth parameters.
@@ -1188,7 +1188,7 @@ class EntityTypesClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.EntityTypesClient({
    *   // optional auth parameters.

diff --git a/packages/google-cloud-dialogflow/src/v2/intents_client.js b/packages/google-cloud-dialogflow/src/v2/intents_client.js
@@ -329,7 +329,7 @@ class IntentsClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.IntentsClient({
    *   // optional auth parameters.
@@ -427,7 +427,7 @@ class IntentsClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.IntentsClient({
    *   // optional auth parameters.
@@ -482,7 +482,7 @@ class IntentsClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.IntentsClient({
    *   // optional auth parameters.
@@ -543,7 +543,7 @@ class IntentsClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.IntentsClient({
    *   // optional auth parameters.
@@ -611,7 +611,7 @@ class IntentsClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.IntentsClient({
    *   // optional auth parameters.
@@ -660,7 +660,7 @@ class IntentsClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.IntentsClient({
    *   // optional auth parameters.
@@ -726,7 +726,7 @@ class IntentsClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.IntentsClient({
    *   // optional auth parameters.
@@ -834,7 +834,7 @@ class IntentsClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.IntentsClient({
    *   // optional auth parameters.

diff --git a/packages/google-cloud-dialogflow/src/v2/session_entity_types_client.js b/packages/google-cloud-dialogflow/src/v2/session_entity_types_client.js
@@ -248,7 +248,7 @@ class SessionEntityTypesClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.SessionEntityTypesClient({
    *   // optional auth parameters.
@@ -340,7 +340,7 @@ class SessionEntityTypesClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.SessionEntityTypesClient({
    *   // optional auth parameters.
@@ -386,7 +386,7 @@ class SessionEntityTypesClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.SessionEntityTypesClient({
    *   // optional auth parameters.
@@ -437,7 +437,7 @@ class SessionEntityTypesClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.SessionEntityTypesClient({
    *   // optional auth parameters.
@@ -500,7 +500,7 @@ class SessionEntityTypesClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.SessionEntityTypesClient({
    *   // optional auth parameters.
@@ -549,7 +549,7 @@ class SessionEntityTypesClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.SessionEntityTypesClient({
    *   // optional auth parameters.

diff --git a/packages/google-cloud-dialogflow/src/v2/sessions_client.js b/packages/google-cloud-dialogflow/src/v2/sessions_client.js
@@ -235,7 +235,7 @@ class SessionsClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.SessionsClient({
    *   // optional auth parameters.
@@ -281,7 +281,7 @@ class SessionsClient {
    *
    * @example
    *
-   * const dialogflow = require('dialogflow.v2');
+   * const dialogflow = require('@google-cloud/dialogflow');
    *
    * const client = new dialogflow.v2.SessionsClient({
    *   // optional auth parameters.