From ce0aab66319fe58eabca262abe490be24ac8dfbd Mon Sep 17 00:00:00 2001 From: Daniel Houck Date: Wed, 18 Mar 2026 23:26:39 -0400 Subject: [PATCH] Fix RPC method return value documentation --- src/main/java/li/cil/oc2/api/bus/device/object/Callbacks.java | 2 +- src/main/scripts/lib/lua/devices.lua | 4 ++++ src/main/scripts/lib/micropython/devices.py | 4 ++++ 3 files changed, 9 insertions(+), 1 deletion(-) diff --git a/src/main/java/li/cil/oc2/api/bus/device/object/Callbacks.java b/src/main/java/li/cil/oc2/api/bus/device/object/Callbacks.java index 2fccd3efd..c36805f52 100644 --- a/src/main/java/li/cil/oc2/api/bus/device/object/Callbacks.java +++ b/src/main/java/li/cil/oc2/api/bus/device/object/Callbacks.java @@ -184,7 +184,7 @@ public ConstructorData(final Object target, final Method method) { description = callbackVisitor.description; } if (Strings.isNotBlank(callbackVisitor.returnValueDescription)) { - returnValueDescription = callbackVisitor.description; + returnValueDescription = callbackVisitor.returnValueDescription; } parameterDescriptions.putAll(callbackVisitor.parameterDescriptions); diff --git a/src/main/scripts/lib/lua/devices.lua b/src/main/scripts/lib/lua/devices.lua index 6cb9f4bc8..532528b00 100644 --- a/src/main/scripts/lib/lua/devices.lua +++ b/src/main/scripts/lib/lua/devices.lua @@ -61,6 +61,10 @@ Device.__tostring = function(self) i = i + 1 end end + + if method.returnValueDescription then + doc = doc .. " Returns: " .. method.returnValueDescription .. "\n" + end end return doc diff --git a/src/main/scripts/lib/micropython/devices.py b/src/main/scripts/lib/micropython/devices.py index 9232d2b01..b9d96d358 100644 --- a/src/main/scripts/lib/micropython/devices.py +++ b/src/main/scripts/lib/micropython/devices.py @@ -50,6 +50,10 @@ def __str__(self): doc += "args" + str(i) doc += " " + p["description"] + "\n" i += 1 + + if method.get("returnValueDescription"): + doc += f" Returns: {method['returnValueDescription']}\n" + return doc