Skip to content

Commit

Permalink
docs: add backticks to JavaScript samples in jsdoc (#317)
Browse files Browse the repository at this point in the history 
This PR was generated using Autosynth. 🌈

Here's the log from Synthtool:
```
synthtool > Executing /tmpfs/src/git/autosynth/working_repo/synth.py.
synthtool > Ensuring dependencies.
synthtool > Pulling artman image.
latest: Pulling from googleapis/artman
Digest: sha256:7231f27272231a884e09edb5953148c85ecd8467780d33c4a35c3e507885715b
Status: Image is up to date for googleapis/artman:latest
synthtool > Cloning googleapis.
synthtool > Running generator for google/cloud/speech/artman_speech_v1.yaml.
synthtool > Generated code into /home/kbuilder/.cache/synthtool/googleapis/artman-genfiles/js/speech-v1.
synthtool > Replaced '(mockBidiStreamingGrpcMethod\\()request' in test/gapic-v1.js.
synthtool > Replaced 'stream\\.write\\(request\\)' in test/gapic-v1.js.
synthtool > Replaced '// Mock request\n\\s*const request = {};' in test/gapic-v1.js.
synthtool > Running generator for google/cloud/speech/artman_speech_v1p1beta1.yaml.
synthtool > Generated code into /home/kbuilder/.cache/synthtool/googleapis/artman-genfiles/js/speech-v1p1beta1.
synthtool > Replaced '(mockBidiStreamingGrpcMethod\\()request' in test/gapic-v1p1beta1.js.
synthtool > Replaced 'stream\\.write\\(request\\)' in test/gapic-v1p1beta1.js.
synthtool > Replaced '// Mock request\n\\s*const request = {};' in test/gapic-v1p1beta1.js.
.eslintignore
.eslintrc.yml
.github/ISSUE_TEMPLATE/bug_report.md
.github/ISSUE_TEMPLATE/feature_request.md
.github/ISSUE_TEMPLATE/support_request.md
.jsdoc.js
.kokoro/common.cfg
.kokoro/continuous/node10/common.cfg
.kokoro/continuous/node10/docs.cfg
.kokoro/continuous/node10/lint.cfg
.kokoro/continuous/node10/samples-test.cfg
.kokoro/continuous/node10/system-test-grpcjs.cfg
.kokoro/continuous/node10/system-test.cfg
.kokoro/continuous/node10/test.cfg
.kokoro/continuous/node11/common.cfg
.kokoro/continuous/node11/test.cfg
.kokoro/continuous/node6/common.cfg
.kokoro/continuous/node6/test.cfg
.kokoro/continuous/node8/common.cfg
.kokoro/continuous/node8/test.cfg
.kokoro/docs.sh
.kokoro/lint.sh
.kokoro/presubmit/node10/common.cfg
.kokoro/presubmit/node10/docs.cfg
.kokoro/presubmit/node10/lint.cfg
.kokoro/presubmit/node10/samples-test.cfg
.kokoro/presubmit/node10/system-test-grpcjs.cfg
.kokoro/presubmit/node10/system-test.cfg
.kokoro/presubmit/node10/test.cfg
.kokoro/presubmit/node11/common.cfg
.kokoro/presubmit/node11/test.cfg
.kokoro/presubmit/node6/common.cfg
.kokoro/presubmit/node6/test.cfg
.kokoro/presubmit/node8/common.cfg
.kokoro/presubmit/node8/test.cfg
.kokoro/presubmit/windows/common.cfg
.kokoro/presubmit/windows/test.cfg
.kokoro/publish.sh
.kokoro/release/publish.cfg
.kokoro/samples-test.sh
.kokoro/system-test.sh
.kokoro/test.bat
.kokoro/test.sh
.kokoro/trampoline.sh
.nycrc
.prettierignore
.prettierrc
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
codecov.yaml
renovate.json

> grpc@1.19.0 install /tmpfs/src/git/autosynth/working_repo/node_modules/grpc
> node-pre-gyp install --fallback-to-build --library=static_library

node-pre-gyp WARN Using needle for node-pre-gyp https download 
[grpc] Success: "/tmpfs/src/git/autosynth/working_repo/node_modules/grpc/src/node/extension_binary/node-v57-linux-x64-glibc/grpc_node.node" is installed via remote

> protobufjs@6.8.8 postinstall /tmpfs/src/git/autosynth/working_repo/node_modules/protobufjs
> node scripts/postinstall

npm notice created a lockfile as package-lock.json. You should commit this file.
npm WARN optional SKIPPING OPTIONAL DEPENDENCY: fsevents@1.2.7 (node_modules/fsevents):
npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@1.2.7: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})

added 1124 packages from 1321 contributors and audited 6925 packages in 24.221s
found 1 low severity vulnerability
  run `npm audit fix` to fix them, or `npm audit` for details

> @google-cloud/speech@2.3.0 fix /tmpfs/src/git/autosynth/working_repo
> eslint --fix '**/*.js'


/tmpfs/src/git/autosynth/working_repo/samples/betaFeatures.js
   31:26  error  "@google-cloud/speech" is not found  node/no-missing-require
   80:26  error  "@google-cloud/speech" is not found  node/no-missing-require
  131:26  error  "@google-cloud/speech" is not found  node/no-missing-require
  172:26  error  "@google-cloud/speech" is not found  node/no-missing-require
  211:26  error  "@google-cloud/speech" is not found  node/no-missing-require
  248:26  error  "@google-cloud/speech" is not found  node/no-missing-require
  288:26  error  "@google-cloud/speech" is not found  node/no-missing-require
  334:26  error  "@google-cloud/speech" is not found  node/no-missing-require

/tmpfs/src/git/autosynth/working_repo/samples/MicrophoneStream.js
  46:26  error  "node-record-lpcm16" is not found    node/no-missing-require
  49:26  error  "@google-cloud/speech" is not found  node/no-missing-require

/tmpfs/src/git/autosynth/working_repo/samples/quickstart.js
  21:26  error  "@google-cloud/speech" is not found  node/no-missing-require

/tmpfs/src/git/autosynth/working_repo/samples/recognize.js
   35:26  error  "@google-cloud/speech" is not found  node/no-missing-require
   79:26  error  "@google-cloud/speech" is not found  node/no-missing-require
  124:26  error  "@google-cloud/speech" is not found  node/no-missing-require
  182:26  error  "@google-cloud/speech" is not found  node/no-missing-require
  231:26  error  "@google-cloud/speech" is not found  node/no-missing-require
  279:26  error  "@google-cloud/speech" is not found  node/no-missing-require
  344:26  error  "@google-cloud/speech" is not found  node/no-missing-require
  383:26  error  "node-record-lpcm16" is not found    node/no-missing-require
  386:26  error  "@google-cloud/speech" is not found  node/no-missing-require
  449:26  error  "@google-cloud/speech" is not found  node/no-missing-require
  501:26  error  "@google-cloud/speech" is not found  node/no-missing-require
  551:26  error  "@google-cloud/speech" is not found  node/no-missing-require
  600:26  error  "@google-cloud/speech" is not found  node/no-missing-require
  643:26  error  "@google-cloud/speech" is not found  node/no-missing-require
  684:26  error  "@google-cloud/speech" is not found  node/no-missing-require

/tmpfs/src/git/autosynth/working_repo/samples/recognize.v1p1beta1.js
  38:26  error  "@google-cloud/speech" is not found  node/no-missing-require

/tmpfs/src/git/autosynth/working_repo/samples/system-test/betaFeatures.test.js
  19:26  error  "chai" is not found  node/no-missing-require

/tmpfs/src/git/autosynth/working_repo/samples/system-test/MicrophoneStream.test.js
  19:26  error  "chai" is not found  node/no-missing-require

/tmpfs/src/git/autosynth/working_repo/samples/system-test/recognize.test.js
  19:27  error  "@google-cloud/storage" is not found  node/no-missing-require
  20:26  error  "chai" is not found                   node/no-missing-require

/tmpfs/src/git/autosynth/working_repo/samples/system-test/recognize.v1p1beta1.test.js
  19:26  error  "chai" is not found  node/no-missing-require

✖ 32 problems (32 errors, 0 warnings)

npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! @google-cloud/speech@2.3.0 fix: `eslint --fix '**/*.js'`
npm ERR! Exit status 1
npm ERR! 
npm ERR! Failed at the @google-cloud/speech@2.3.0 fix script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     /home/kbuilder/.npm/_logs/2019-03-14T11_22_00_149Z-debug.log
synthtool > Cleaned up 2 temporary directories.
synthtool > Wrote metadata to synth.metadata.

```
  • Loading branch information
@yoshi-automation @stephenplusplus
yoshi-automation authored and stephenplusplus committed Mar 14, 2019
1 parent 81c5ad5 commit 166e5d0
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion packages/google-cloud-speech/src/v1/doc/google/longrunning/doc_operations.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
*
* @property {boolean} done
* If the value is `false`, it means the operation is still in progress.
* If true, the operation is completed, and either `error` or `response` is
* If `true`, the operation is completed, and either `error` or `response` is
* available.
*
* @property {Object} error
Expand Down
2 changes: 1 addition & 1 deletion packages/google-cloud-speech/src/v1p1beta1/doc/google/longrunning/doc_operations.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
*
* @property {boolean} done
* If the value is `false`, it means the operation is still in progress.
* If true, the operation is completed, and either `error` or `response` is
* If `true`, the operation is completed, and either `error` or `response` is
* available.
*
* @property {Object} error
Expand Down
10 changes: 5 additions & 5 deletions packages/google-cloud-speech/synth.metadata
View file
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
{
"updateTime": "2019-03-12T11:25:13.603843Z",
"updateTime": "2019-03-14T11:22:00.159165Z",
"sources": [
{
"generator": {
"name": "artman",
"version": "0.16.16",
"dockerImage": "googleapis/artman@sha256:30babbfce7f05a62b1892c63c575aa2c8c502eb4bcc8f3bb90ec83e955d5d319"
"version": "0.16.17",
"dockerImage": "googleapis/artman@sha256:7231f27272231a884e09edb5953148c85ecd8467780d33c4a35c3e507885715b"
}
},
{
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
"sha": "abd1c9a99c5cd7179d8e5e0c8d4c8e761054cc78",
"internalRef": "237945492"
"sha": "d05a746ba27b89374c7407c88c0d5dabfb0afc7c",
"internalRef": "238372434"
}
},
{
Expand Down

0 comments on commit 166e5d0

Please sign in to comment.