Skip to content

Commit

Permalink
fix(docs): fix <caption> tag rendering in Key doc (#439)
Browse files Browse the repository at this point in the history
  • Loading branch information
jkwlui authored and JustinBeckwith committed Jun 13, 2019
1 parent 278c1c5 commit 2edd95c
Showing 1 changed file with 17 additions and 8 deletions.
25 changes: 17 additions & 8 deletions src/entity.ts
Original file line number Diff line number Diff line change
Expand Up @@ -174,21 +174,28 @@ export namespace entity {
* @param {string} [options.namespace] Optional namespace.
*
* @example
* <caption>Create an incomplete key with a kind value of `Company`.</caption>
* //-
* // Create an incomplete key with a kind value of `Company`.
* //-
* const {Datastore} = require('@google-cloud/datastore');
* const datastore = new Datastore();
* const key = datastore.key('Company');
*
* @example
* <caption>Create a complete key with a kind value of `Company` and id
* `123`.</caption> const {Datastore} = require('@google-cloud/datastore');
* //-
* // Create a complete key with a kind value of `Company` and id`123`.
* //-
* const {Datastore} = require('@google-cloud/datastore');
* const datastore = new Datastore();
* const key = datastore.key(['Company', 123]);
*
* @example
* <caption>If the ID integer is outside the bounds of a JavaScript Number
* object, create an Int.</caption> const {Datastore} =
* require('@google-cloud/datastore'); const datastore = new Datastore();
* //-
* // If the ID integer is outside the bounds of a JavaScript Number
* // object, create an Int.
* //-
* const {Datastore} = require('@google-cloud/datastore');
* const datastore = new Datastore();
* const key = datastore.key([
* 'Company',
* datastore.int('100000000000001234')
Expand All @@ -202,8 +209,10 @@ export namespace entity {
* const key = datastore.key(['Company', 'Google']);
*
* @example
* <caption>Create a complete key from a provided namespace and
* path.</caption> const {Datastore} = require('@google-cloud/datastore');
* //-
* // Create a complete key from a provided namespace and path.
* //-
* const {Datastore} = require('@google-cloud/datastore');
* const datastore = new Datastore();
* const key = datastore.key({
* namespace: 'My-NS',
Expand Down

0 comments on commit 2edd95c

Please sign in to comment.