From 8dd6fd058a2c960c820ad17dcde53efeb3d65d14 Mon Sep 17 00:00:00 2001 From: Nathan Franke Date: Thu, 26 Nov 2020 15:25:02 -0600 Subject: [PATCH] Improve Ambiguous StreamPeerTCP `set_no_delay` Documentation (cherry picked from commit dbff9570285f46b69429fdef79f9272fbc77ca19) --- doc/classes/StreamPeerTCP.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/classes/StreamPeerTCP.xml b/doc/classes/StreamPeerTCP.xml index 37cda693232e..eb4048a6c550 100644 --- a/doc/classes/StreamPeerTCP.xml +++ b/doc/classes/StreamPeerTCP.xml @@ -61,8 +61,8 @@ - Disables Nagle's algorithm to improve latency for small packets. - [b]Note:[/b] For applications that send large packets or need to transfer a lot of data, this can decrease the total available bandwidth. + If [code]enabled[/code] is [code]true[/code], packets will be sent immediately. If [code]enabled[/code] is [code]false[/code] (the default), packet transfers will be delayed and combined using [url=https://en.wikipedia.org/wiki/Nagle%27s_algorithm]Nagle's algorithm[/url]. + [b]Note:[/b] It's recommended to leave this disabled for applications that send large packets or need to transfer a lot of data, as enabling this can decrease the total available bandwidth.