Add a description for the new constructor

marcomagdy · marcomagdy · commit a31cc25324f9 · 2019-12-02T12:10:39.000-08:00
Signed-off-by: Marco Magdy &lt;mmagdy@gmail.com&gt;
diff --git a/include/aws/lambda-runtime/runtime.h b/include/aws/lambda-runtime/runtime.h
@@ -92,6 +92,11 @@ class invocation_response {
     invocation_response() = default;
 
 public:
+    // Create a success or failure response. Typically, you should use the static functions invocation_response::success
+    // and invocation_response::failure, however, invocation_response::failure doesn't allow for arbitrary payloads.
+    // To support clients that need to control the entire error response body (e.g. adding a stack trace), this
+    // constructor should be used instead.
+    // Note: adding an overload to invocation_response::failure is not feasible since the parameter types are the same.
     invocation_response(std::string const& payload, std::string const& content_type, bool success)
         : m_payload(payload), m_content_type(content_type), m_success(success)
     {
