diff options
| author |  yang-g <yangg@google.com> | 2017-06-02 16:14:45 -0700 |
|---|---|---|
| committer | yang-g <yangg@google.com> | 2017-06-02 16:30:54 -0700 |
| commit | 63610c4740fb5e4e773beb32b658605933741272 (patch) | |
| tree | 7656e0f457176048fa2834554adfc865d43cbcdf /include | |
| parent | 01b536c3e74609273ec4042ddb158be32c3fc6c7 (diff) | |
Update comments to discourage having an OK status with error_message
Diffstat (limited to 'include')
| -rw-r--r-- | include/grpc++/impl/codegen/status.h | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/include/grpc++/impl/codegen/status.h b/include/grpc++/impl/codegen/status.h index 31fd6cdbe7..994d631181 100644 --- a/include/grpc++/impl/codegen/status.h +++ b/include/grpc++/impl/codegen/status.h @@ -47,11 +47,14 @@ class Status { /// Construct an OK instance. Status() : code_(StatusCode::OK) {} - /// Construct an instance with associated \a code and \a error_message + /// Construct an instance with associated \a code and \a error_message. + /// It is an error to construct an OK status with non-empty \a error_message. Status(StatusCode code, const grpc::string& error_message) : code_(code), error_message_(error_message) {} - /// Construct an instance with \a code, \a error_message and \a error_details + /// Construct an instance with \a code, \a error_message and + /// \a error_details. It is an error to construct an OK status with non-empty + /// \a error_message and/or \a error_details. Status(StatusCode code, const grpc::string& error_message, const grpc::string& error_details) : code_(code), |