From b7cc0299b53885d4756edfa06dd7efe530bd6588 Mon Sep 17 00:00:00 2001
From: Scallop Ye <yescallop@gmail.com>
Date: Sat, 1 Jun 2024 22:51:37 +0800
Subject: [PATCH] Update doc

---
 src/component.rs | 29 +++++++++++++++++++----------
 src/lib.rs       |  8 ++++----
 2 files changed, 23 insertions(+), 14 deletions(-)

diff --git a/src/component.rs b/src/component.rs
index de38f06..c18efd2 100644
--- a/src/component.rs
+++ b/src/component.rs
@@ -27,9 +27,14 @@ use std::{
 ///
 /// # Comparison
 ///
-/// `Scheme`s are compared case-insensitively, as the generic URI syntax requires.
+/// `Scheme`s are compared case-insensitively, as required by the generic URI syntax.
+/// You should do a case-insensitive comparison if the scheme specification allows
+/// both letter cases in the scheme name.
 ///
-/// [`as_str`]: Self::as_str
+/// When designing a new scheme, you may find it helpful to restrict the scheme name
+/// to lowercase as it is normalized to lowercase in the generic URI syntax.
+/// Doing so reduces variations in URIs and may contribute to the long-term
+/// interoperability of the scheme.
 #[derive(RefCastCustom)]
 #[repr(transparent)]
 pub struct Scheme {
@@ -144,7 +149,7 @@ impl<'i, 'o, T: BorrowOrShare<'i, 'o, str>> Authority<T> {
         self.meta().host_bounds
     }
 
-    /// Returns the authority as a string slice.
+    /// Returns the authority component as a string slice.
     ///
     /// # Examples
     ///
@@ -161,7 +166,7 @@ impl<'i, 'o, T: BorrowOrShare<'i, 'o, str>> Authority<T> {
         self.uri.slice(self.start(), self.end())
     }
 
-    /// Returns the [userinfo] subcomponent.
+    /// Returns the optional [userinfo] subcomponent.
     ///
     /// [userinfo]: https://datatracker.ietf.org/doc/html/rfc3986/#section-3.2.1
     ///
@@ -183,7 +188,9 @@ impl<'i, 'o, T: BorrowOrShare<'i, 'o, str>> Authority<T> {
 
     /// Returns the [host] subcomponent as a string slice.
     ///
-    /// The square brackets enclosing an IP literal are included.
+    /// The square brackets enclosing an IPv6 or IPvFuture address are included.
+    /// 
+    /// Note that the host subcomponent is case-insensitive in the generic URI syntax.
     ///
     /// [host]: https://datatracker.ietf.org/doc/html/rfc3986/#section-3.2.2
     ///
@@ -204,6 +211,8 @@ impl<'i, 'o, T: BorrowOrShare<'i, 'o, str>> Authority<T> {
     }
 
     /// Returns the parsed [host] subcomponent.
+    /// 
+    /// Note that the host subcomponent is case-insensitive in the generic URI syntax.
     ///
     /// [host]: https://datatracker.ietf.org/doc/html/rfc3986/#section-3.2.2
     ///
@@ -250,7 +259,7 @@ impl<'i, 'o, T: BorrowOrShare<'i, 'o, str>> Authority<T> {
         }
     }
 
-    /// Returns the [port] subcomponent.
+    /// Returns the optional [port] subcomponent.
     ///
     /// [port]: https://datatracker.ietf.org/doc/html/rfc3986/#section-3.2.3
     ///
@@ -275,9 +284,9 @@ impl<'i, 'o, T: BorrowOrShare<'i, 'o, str>> Authority<T> {
     /// let authority = uri.authority().unwrap();
     /// assert_eq!(authority.port(), None);
     ///
-    /// let uri = Uri::parse("//localhost:66666/")?;
+    /// let uri = Uri::parse("//localhost:123456/")?;
     /// let authority = uri.authority().unwrap();
-    /// assert_eq!(authority.port(), Some("66666"));
+    /// assert_eq!(authority.port(), Some("123456"));
     /// # Ok::<_, fluent_uri::error::ParseError>(())
     /// ```
     #[must_use]
@@ -286,7 +295,7 @@ impl<'i, 'o, T: BorrowOrShare<'i, 'o, str>> Authority<T> {
         (host_end != end).then(|| self.uri.slice(host_end + 1, end))
     }
 
-    /// Converts the [port] subcomponent to `u16`.
+    /// Converts the [port] subcomponent to `u16`, if present.
     ///
     /// Leading zeros are ignored.
     /// Returns `Ok(None)` if the port is not present or is empty,
@@ -323,7 +332,7 @@ impl<'i, 'o, T: BorrowOrShare<'i, 'o, str>> Authority<T> {
             .transpose()
     }
 
-    /// Converts the authority to an iterator of resolved [`SocketAddr`]s.
+    /// Converts the authority component to an iterator of resolved [`SocketAddr`]s.
     ///
     /// The default port is used if the port component is not present or is empty.
     ///
diff --git a/src/lib.rs b/src/lib.rs
index 0b72ceb..877a624 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -271,7 +271,7 @@ impl<'i, 'o, T: BorrowOrShare<'i, 'o, str>> Uri<T> {
         EStr::new_validated(self.slice(start, end))
     }
 
-    /// Returns the [scheme] component.
+    /// Returns the optional [scheme] component.
     ///
     /// [scheme]: https://datatracker.ietf.org/doc/html/rfc3986/#section-3.1
     #[must_use]
@@ -280,7 +280,7 @@ impl<'i, 'o, T: BorrowOrShare<'i, 'o, str>> Uri<T> {
             .map(|i| Scheme::new_validated(self.slice(0, i.get())))
     }
 
-    /// Returns the [authority] component.
+    /// Returns the optional [authority] component.
     ///
     /// [authority]: https://datatracker.ietf.org/doc/html/rfc3986/#section-3.2
     #[must_use]
@@ -303,7 +303,7 @@ impl<'i, 'o, T: BorrowOrShare<'i, 'o, str>> Uri<T> {
         self.eslice(self.path_bounds.0, self.path_bounds.1)
     }
 
-    /// Returns the [query] component.
+    /// Returns the optional [query] component.
     ///
     /// [query]: https://datatracker.ietf.org/doc/html/rfc3986/#section-3.4
     #[must_use]
@@ -317,7 +317,7 @@ impl<'i, 'o, T: BorrowOrShare<'i, 'o, str>> Uri<T> {
         (query_or_path_end != self.len()).then_some(query_or_path_end + 1)
     }
 
-    /// Returns the [fragment] component.
+    /// Returns the optional [fragment] component.
     ///
     /// [fragment]: https://datatracker.ietf.org/doc/html/rfc3986/#section-3.5
     #[must_use]