Fix rustdoc errors in components/shared (#31582)

* Fixed error in documentation in components>shared>embedder>lib.rs * fixed documentation warning in compoenents>shared>net>request.rs * Fixed the documentation (URL issue) in components>shared>script>lib.rs
servo · Mar 8, 2024 · dd6c929 · dd6c929
1 parent 6b5a514
commit dd6c929
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/components/shared/embedder/lib.rs b/components/shared/embedder/lib.rs
@@ -176,7 +176,7 @@ pub enum EmbedderMsg {
     SetCursor(Cursor),
     /// A favicon was detected
     NewFavicon(ServoUrl),
-    /// <head> tag finished parsing
+    /// `<head>` tag finished parsing
     HeadParsed,
     /// The history state has changed.
     HistoryChanged(Vec<ServoUrl>, usize),

diff --git a/components/shared/net/request.rs b/components/shared/net/request.rs
@@ -186,7 +186,7 @@ impl RequestBody {
         }
     }
 
-    /// Step 12 of https://fetch.spec.whatwg.org/#concept-http-redirect-fetch
+    /// Step 12 of <https://fetch.spec.whatwg.org/#concept-http-redirect-fetch>
     pub fn extract_source(&mut self) {
         match self.source {
             BodySource::Null => panic!("Null sources should never be re-directed."),

diff --git a/components/shared/script/lib.rs b/components/shared/script/lib.rs
@@ -1350,6 +1350,6 @@ pub enum GamepadUpdateType {
     /// <https://www.w3.org/TR/gamepad/#dfn-represents-a-standard-gamepad-axis>
     Axis(usize, f64),
     /// Button index and input value
-    /// <https://www.w3.org/TR/gamepad/#dfn-represents-a-standard-gamepad-button
+    /// <https://www.w3.org/TR/gamepad/#dfn-represents-a-standard-gamepad-button>
     Button(usize, f64),
 }