fix(docs): snippets are now replaced in jsdoc comments (#815)

Benjamin E. Coe · web-flow · commit b0b26ade6096 · 2019-11-18T19:14:12.000-08:00
diff --git a/.jsdoc.js b/.jsdoc.js
@@ -26,7 +26,8 @@ module.exports = {
     destination: './docs/'
   },
   plugins: [
-    'plugins/markdown'
+    'plugins/markdown',
+    'jsdoc-region-tag'
   ],
   source: {
     excludePattern: '(^|\\/|\\\\)[._]',
diff --git a/package.json b/package.json
@@ -91,6 +91,7 @@
     "intelli-espower-loader": "^1.0.1",
     "jsdoc": "^3.6.2",
     "jsdoc-fresh": "^1.0.1",
+    "jsdoc-region-tag": "^1.0.2",
     "linkinator": "^1.5.0",
     "mkdirp": "^0.5.1",
     "mocha": "^6.0.0",
diff --git a/system-test/pubsub.ts b/system-test/pubsub.ts
@@ -710,23 +710,22 @@ describe('pubsub', () => {
     describe('seeking', () => {
       let subscription: Subscription;
       let messageId: string;
+      const snapshotName = generateSnapshotName();
 
-      beforeEach(() => {
+      beforeEach(async () => {
         subscription = topic.subscription(generateSubName());
-
-        return subscription
-          .create()
-          .then(() => {
-            return topic.publish(Buffer.from('Hello, world!'));
-          })
-          .then(_messageId => {
-            messageId = _messageId;
-          });
+        await subscription.create();
+        messageId = await topic.publish(Buffer.from('Hello, world!'));
+        // The first call to `createSnapshot` consistently fails,
+        // see: https://github.com/googleapis/nodejs-pubsub/issues/821
+        try {
+          await subscription.createSnapshot(snapshotName);
+        } catch (err) {
+          console.warn(err.message);
+        }
       });
 
       it('should seek to a snapshot', done => {
-        const snapshotName = generateSnapshotName();
-
         subscription.createSnapshot(snapshotName, (err, snapshot) => {
           assert.ifError(err);
 
