Merge pull request #22 from alimkoca/patch-1

lib.rs doc comment: .auth() method isn't expressed
emreyalvac · Jul 9, 2023 · f1b4aa8 · f1b4aa8
2 parents 4b7d5ab + bdeb152
commit f1b4aa8
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -39,9 +39,13 @@ impl Firebase {
     }
 
     /// ```
+    /// const URI = "...";
+    /// const AUTH_KEY = "...";
+    ///
     /// use firebase_rs::Firebase;
     ///
     /// let firebase = Firebase::new("https://myfirebase.firebaseio.com").unwrap();
+    /// let parsed = firebase.auth(URI, AUTH_KEY);
     /// ```
     pub fn auth(uri: &str, auth_key: &str) -> UrlParseResult<Self>
         where