Skip to content

Commit

Permalink
chore(docs): formatting updates (#454)
Browse files Browse the repository at this point in the history
  • Loading branch information
yoshi-automation authored and JustinBeckwith committed May 8, 2019
1 parent 3d5111f commit aae0c5e
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 45 deletions.
3 changes: 2 additions & 1 deletion src/v2/doc/google/protobuf/doc_any.js
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,8 @@
*
* @property {string} typeUrl
* A URL/resource name that uniquely identifies the type of the serialized
* protocol buffer message. The last segment of the URL's path must represent
* protocol buffer message. This string must contain at least
* one "/" character. The last segment of the URL's path must represent
* the fully qualified name of the type (as in
* `path/google.protobuf.Duration`). The name should be in a canonical form
* (e.g., leading "." is not accepted).
Expand Down
44 changes: 18 additions & 26 deletions src/v2/doc/google/protobuf/doc_field_mask.js
Original file line number Diff line number Diff line change
Expand Up @@ -84,57 +84,49 @@
* describe the updated values, the API ignores the values of all
* fields not covered by the mask.
*
* If a repeated field is specified for an update operation, the existing
* repeated values in the target resource will be overwritten by the new values.
* Note that a repeated field is only allowed in the last position of a `paths`
* string.
* If a repeated field is specified for an update operation, new values will
* be appended to the existing repeated field in the target resource. Note that
* a repeated field is only allowed in the last position of a `paths` string.
*
* If a sub-message is specified in the last position of the field mask for an
* update operation, then the existing sub-message in the target resource is
* overwritten. Given the target message:
* update operation, then new value will be merged into the existing sub-message
* in the target resource.
*
* For example, given the target message:
*
* f {
* b {
* d : 1
* x : 2
* d: 1
* x: 2
* }
* c : 1
* c: [1]
* }
*
* And an update message:
*
* f {
* b {
* d : 10
* d: 10
* }
* c: [2]
* }
*
* then if the field mask is:
*
* paths: "f.b"
* paths: ["f.b", "f.c"]
*
* then the result will be:
*
* f {
* b {
* d : 10
* d: 10
* x: 2
* }
* c : 1
* c: [1, 2]
* }
*
* However, if the update mask was:
*
* paths: "f.b.d"
*
* then the result would be:
*
* f {
* b {
* d : 10
* x : 2
* }
* c : 1
* }
* An implementation may provide options to override this default behavior for
* repeated and message fields.
*
* In order to reset a field's value to the default, the field must
* be in the mask and set to the default value in the provided resource.
Expand Down
26 changes: 14 additions & 12 deletions src/v2/doc/google/protobuf/doc_timestamp.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,19 @@
// to be loaded as the JS file.

/**
* A Timestamp represents a point in time independent of any time zone
* or calendar, represented as seconds and fractions of seconds at
* nanosecond resolution in UTC Epoch time. It is encoded using the
* Proleptic Gregorian Calendar which extends the Gregorian calendar
* backwards to year one. It is encoded assuming all minutes are 60
* seconds long, i.e. leap seconds are "smeared" so that no leap second
* table is needed for interpretation. Range is from
* 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z.
* By restricting to that range, we ensure that we can convert to
* and from RFC 3339 date strings.
* See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt).
* A Timestamp represents a point in time independent of any time zone or local
* calendar, encoded as a count of seconds and fractions of seconds at
* nanosecond resolution. The count is relative to an epoch at UTC midnight on
* January 1, 1970, in the proleptic Gregorian calendar which extends the
* Gregorian calendar backwards to year one.
*
* All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
* second table is needed for interpretation, using a [24-hour linear
* smear](https://developers.google.com/time/smear).
*
* The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
* restricting to that range, we ensure that we can convert to and from [RFC
* 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
*
* # Examples
*
Expand Down Expand Up @@ -91,7 +93,7 @@
* method. In Python, a standard `datetime.datetime` object can be converted
* to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime)
* with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one
* can use the Joda Time's [`ISODateTimeFormat.dateTime()`](https://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime--) to obtain a formatter capable of generating timestamps in this format.
* can use the Joda Time's [`ISODateTimeFormat.dateTime()`](https://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D) to obtain a formatter capable of generating timestamps in this format.
*
* @property {number} seconds
* Represents seconds of UTC time since Unix epoch
Expand Down
12 changes: 6 additions & 6 deletions synth.metadata
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
{
"updateTime": "2019-03-28T11:36:01.654509Z",
"updateTime": "2019-04-21T11:47:20.841946Z",
"sources": [
{
"generator": {
"name": "artman",
"version": "0.16.20",
"dockerImage": "googleapis/artman@sha256:e3c054a2fb85a12481c722af616c7fb6f1d02d862248385eecbec3e4240ebd1e"
"version": "0.16.26",
"dockerImage": "googleapis/artman@sha256:314eae2a40f6f7822db77365cf5f45bd513d628ae17773fd0473f460e7c2a665"
}
},
{
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
"sha": "6a84b3267b0a95e922608b9891219075047eee29",
"internalRef": "240640999"
"sha": "3369c803f56d52662ea3792076deb8545183bdb0",
"internalRef": "244282812"
}
},
{
"template": {
"name": "node_library",
"origin": "synthtool.gcp",
"version": "2019.2.26"
"version": "2019.4.10"
}
}
],
Expand Down

0 comments on commit aae0c5e

Please sign in to comment.