From f096d763f98ed7606a552a14109f47b47d880ffe Mon Sep 17 00:00:00 2001 From: Emanuele Goldoni Date: Tue, 17 Oct 2023 13:08:47 +0200 Subject: [PATCH] Fix documentation (see #103) --- docs/api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api.md b/docs/api.md index d59d397..f75bef3 100644 --- a/docs/api.md +++ b/docs/api.md @@ -891,7 +891,7 @@ host: the host to ping (string) ttl: Time of live (optional, defaults to 128). Maximum number of routers the request can be forwarded to. #### Returns -WL_PING_SUCCESS when the ping was successful +the RTT value (>=0) when the ping was successful WL_PING_DEST_UNREACHABLE when the destination (IP or host is unreachable) WL_PING_TIMEOUT when the ping times out WL_PING_UNKNOWN_HOST when the host cannot be resolved via DNS