Documentation fix: it's TCP_NODELAY, not SO_NODELAY (#1710)

seanmonstar · Jan 3, 2023 · c2a1870 · c2a1870
1 parent b16ea79
commit c2a1870
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/src/async_impl/client.rs b/src/async_impl/client.rs
@@ -1000,7 +1000,7 @@ impl ClientBuilder {
 
     // TCP options
 
-    /// Set whether sockets have `SO_NODELAY` enabled.
+    /// Set whether sockets have `TCP_NODELAY` enabled.
     ///
     /// Default is `true`.
     pub fn tcp_nodelay(mut self, enabled: bool) -> ClientBuilder {

diff --git a/src/blocking/client.rs b/src/blocking/client.rs
@@ -466,7 +466,7 @@ impl ClientBuilder {
 
     // TCP options
 
-    /// Set whether sockets have `SO_NODELAY` enabled.
+    /// Set whether sockets have `TCP_NODELAY` enabled.
     ///
     /// Default is `true`.
     pub fn tcp_nodelay(self, enabled: bool) -> ClientBuilder {