From 9420b73d7fd0a4fc2b66aeacc8f2ca833ea1dfa1 Mon Sep 17 00:00:00 2001
From: Gaurav Dhiman <newmanifold000@gmail.com>
Date: Mon, 23 Oct 2023 15:32:55 +0200
Subject: [PATCH] docs(client,server): added note about stability of Builder
 struct default options (#3366)

Closes #3336
---
 src/client/conn/http1.rs | 3 +++
 src/client/conn/http2.rs | 3 +++
 src/server/conn/http1.rs | 3 +++
 src/server/conn/http2.rs | 3 +++
 4 files changed, 12 insertions(+)

diff --git a/src/client/conn/http1.rs b/src/client/conn/http1.rs
index c487b1927a..60db767a42 100644
--- a/src/client/conn/http1.rs
+++ b/src/client/conn/http1.rs
@@ -97,6 +97,9 @@ where
 /// A builder to configure an HTTP connection.
 ///
 /// After setting options, the builder is used to create a handshake future.
+///
+/// **Note**: The default values of options are *not considered stable*. They
+/// are subject to change at any time.
 #[derive(Clone, Debug)]
 pub struct Builder {
     h09_responses: bool,
diff --git a/src/client/conn/http2.rs b/src/client/conn/http2.rs
index ec8ecf3e08..f4cdcd5e9f 100644
--- a/src/client/conn/http2.rs
+++ b/src/client/conn/http2.rs
@@ -50,6 +50,9 @@ where
 /// A builder to configure an HTTP connection.
 ///
 /// After setting options, the builder is used to create a handshake future.
+///
+/// **Note**: The default values of options are *not considered stable*. They
+/// are subject to change at any time.
 #[derive(Clone, Debug)]
 pub struct Builder<Ex> {
     pub(super) exec: Ex,
diff --git a/src/server/conn/http1.rs b/src/server/conn/http1.rs
index d4b8924e9f..c498636ff9 100644
--- a/src/server/conn/http1.rs
+++ b/src/server/conn/http1.rs
@@ -41,6 +41,9 @@ pin_project_lite::pin_project! {
 }
 
 /// A configuration builder for HTTP/1 server connections.
+///
+/// **Note**: The default values of options are *not considered stable*. They
+/// are subject to change at any time.
 #[derive(Clone, Debug)]
 pub struct Builder {
     timer: Time,
diff --git a/src/server/conn/http2.rs b/src/server/conn/http2.rs
index 1af3d4a36e..d35f2df354 100644
--- a/src/server/conn/http2.rs
+++ b/src/server/conn/http2.rs
@@ -35,6 +35,9 @@ pin_project! {
 }
 
 /// A configuration builder for HTTP/2 server connections.
+///
+/// **Note**: The default values of options are *not considered stable*. They
+/// are subject to change at any time.
 #[derive(Clone, Debug)]
 pub struct Builder<E> {
     exec: E,