kevingurney commented on code in PR #36273:
URL: https://github.com/apache/arrow/pull/36273#discussion_r1240355227
##########
matlab/src/cpp/arrow/matlab/error/error.h:
##########
@@ -17,19 +17,154 @@
#pragma once
-
#include "arrow/status.h"
#include "libmexclass/error/Error.h"
-#include <string_view>
-
+//
+// MATLAB_ERROR_IF_NOT_OK(expr, id)
+//
+// --- Description ---
+//
+// A macro used to return an error to MATLAB if the arrow::Status returned
+// by the specified expression is not "OK" (i.e. error).
+//
+// **NOTE**: This macro should be used inside of the static make() member
function for a
+// Proxy class. Use MATLAB_ERROR_IF_NOT_OK_WITH_CONTEXT inside of a
non-static
+// Proxy member function.
+//
+// --- Arguments ---
+//
+// lhs - variable name to assign to (e.g. auto array)
+// expr - expression that returns an arrow::Status (e.g. builder.Append(...))
+// id - MATLAB error ID string (const char* -
"arrow:matlab:proxy:make:FailedConstruction")
+//
+// --- Example ---
+//
+// MATLAB_ERROR_IF_NOT_OK(builder.Append(...),
error::BUILDER_FAILED_TO_APPEND);
+//
#define MATLAB_ERROR_IF_NOT_OK(expr, id) \
do { \
arrow::Status _status = (expr); \
if (!_status.ok()) { \
return libmexclass::error::Error{(id), _status.message()}; \
} \
- } while (0)
+ } while (0) \
Review Comment:
Sorry about the extra line continuations! I don't have much prior experience
writing macros like this, so this is really helpful.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
