Merge pull request #349 from emanueleg/master

Correct documentation re: non-failure return value of `WiFiClass::ping`
arduino-libraries · Oct 19, 2023 · c4b4959 · c4b4959
2 parents 1634ec2 + 9e3ff41
commit c4b4959
Showing 1 changed file with 1 addition and 1 deletion.
diff --git 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