From 3dd5efe6dad7c29efc162280d958ca412576eefc Mon Sep 17 00:00:00 2001 From: Aurelien DARRAGON Date: Thu, 23 Nov 2023 16:02:14 +0100 Subject: [PATCH] DOC: lua: fix Proxy.get_mode() output Proxy.get_mode() function internally relies on proxy_mode_str() to return the proxy mode. The current function description is exhaustive about the possible outputs for the function. I can't tell if it's relevant or not but it's subject to changes. Here it is the case, the documentation indicates that "health" mode may be returned, which cannot happen since 77e0daef9 ("MEDIUM: proxy: remove obsolete "mode health""). This should be backported up to 2.4 --- doc/lua-api/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/lua-api/index.rst b/doc/lua-api/index.rst index eadf2f2f3..fb39d3308 100644 --- a/doc/lua-api/index.rst +++ b/doc/lua-api/index.rst @@ -1140,7 +1140,7 @@ Proxy class :param class_proxy px: A :ref:`proxy_class` which indicates the manipulated proxy. - :returns: a string "tcp", "http", "health" or "unknown" + :returns: a string "tcp", "http" or "unknown" .. js:function:: Proxy.get_srv_act(px)