Skip to content

Commit f95e9ca

Browse files
committed
Improve doc for Builder
1 parent 51ba1cd commit f95e9ca

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

src/build/mod.rs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,10 @@ impl crate::Error for BuildError {}
104104
/// within a call to [`authority_with`].
105105
/// - Setting [`host`] is mandatory within a call to [`authority_with`].
106106
///
107-
/// You may otherwise skip setting optional components
108-
/// (scheme, authority, userinfo, port, query, and fragment)
109-
/// with [`advance`] or set them optionally with [`optional`].
107+
/// You can omit optional components (scheme, authority, userinfo, port,
108+
/// query, and fragment) by simply not calling their methods.
109+
/// Use [`optional`] with an `Option` to either call a method on `Some`
110+
/// or skip ahead on `None`. Use [`advance`] to skip ahead explicitly.
110111
///
111112
/// The builder typestates are currently private. Please open an issue
112113
/// if it is a problem not being able to name the type of a builder.

0 commit comments

Comments
 (0)