Skip to content

Commit a78495b

Browse files
yoshi-automationJustinBeckwith
authored andcommitted
docs: update API doc comments (#557)
1 parent 257abb9 commit a78495b

File tree

2 files changed

+15
-12
lines changed

2 files changed

+15
-12
lines changed

dev/src/v1/doc/google/rpc/doc_status.js

+12-9
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,14 @@
2727
*
2828
* The `Status` message contains three pieces of data: error code, error
2929
* message, and error details. The error code should be an enum value of
30-
* google.rpc.Code, but it may accept additional error codes if needed. The
31-
* error message should be a developer-facing English message that helps
32-
* developers *understand* and *resolve* the error. If a localized user-facing
33-
* error message is needed, put the localized message in the error details or
34-
* localize it in the client. The optional error details may contain arbitrary
35-
* information about the error. There is a predefined set of error detail types
36-
* in the package `google.rpc` that can be used for common error conditions.
30+
* google.rpc.Code, but it may accept additional error codes
31+
* if needed. The error message should be a developer-facing English message
32+
* that helps developers *understand* and *resolve* the error. If a localized
33+
* user-facing error message is needed, put the localized message in the error
34+
* details or localize it in the client. The optional error details may contain
35+
* arbitrary information about the error. There is a predefined set of error
36+
* detail types in the package `google.rpc` that can be used for common error
37+
* conditions.
3738
*
3839
* # Language mapping
3940
*
@@ -70,12 +71,14 @@
7071
* be used directly after any stripping needed for security/privacy reasons.
7172
*
7273
* @property {number} code
73-
* The status code, which should be an enum value of google.rpc.Code.
74+
* The status code, which should be an enum value of
75+
* google.rpc.Code.
7476
*
7577
* @property {string} message
7678
* A developer-facing error message, which should be in English. Any
7779
* user-facing error message should be localized and sent in the
78-
* google.rpc.Status.details field, or localized by the client.
80+
* google.rpc.Status.details field, or localized
81+
* by the client.
7982
*
8083
* @property {Object[]} details
8184
* A list of messages that carry the error details. There is a common set of

synth.metadata

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"updateTime": "2019-02-24T12:13:23.461769Z",
2+
"updateTime": "2019-02-26T12:29:51.788909Z",
33
"sources": [
44
{
55
"generator": {
@@ -12,8 +12,8 @@
1212
"git": {
1313
"name": "googleapis",
1414
"remote": "https://github.com/googleapis/googleapis.git",
15-
"sha": "59f2494f1b00511bbb813d647cfbe95c949de0fe",
16-
"internalRef": "235350912"
15+
"sha": "29f098cb03a9983cc9cb15993de5da64419046f2",
16+
"internalRef": "235621085"
1717
}
1818
},
1919
{

0 commit comments

Comments
 (0)