From ef2502e7b420f65693fd937fa98b74bf7767b5fd Mon Sep 17 00:00:00 2001 From: lyken Date: Wed, 19 Jun 2024 16:08:09 +0800 Subject: [PATCH] core: more minor doc refine for helper_call_numpy() --- nac3core/src/codegen/builtin_fns.rs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/nac3core/src/codegen/builtin_fns.rs b/nac3core/src/codegen/builtin_fns.rs index a951dd7a..a56da144 100644 --- a/nac3core/src/codegen/builtin_fns.rs +++ b/nac3core/src/codegen/builtin_fns.rs @@ -1044,7 +1044,8 @@ pub fn call_numpy_maximum<'ctx, G: CodeGenerator + ?Sized>( }) } -/// Helper function to create a builtin that takes in either an ndarray or a value and returns a value of the structure. +/// Helper function to create a builtin that takes in either an ndarray or a value and returns a value of the same structure. +/// (e.g, `float` to `float`, `float` to `int`, `ndarray` to `ndarray`, or even `ndarray` to `ndarray`). /// /// * `(arg_ty, arg_val)`: The [`Type`] and llvm value of the input argument. /// * `fn_name`: The name of the function, only used when throwing an error with [`unsupported_type`]