Просмотр исходного кода

Add doc example for `url::Url::parse`.

Corey Farwell 9 лет назад
Родитель
Сommit
e62dbb5194
1 измененных файлов с 8 добавлено и 0 удалено
  1. 8 0
      src/lib.rs

+ 8 - 0
src/lib.rs

@@ -228,6 +228,14 @@ impl<'a> ParseOptions<'a> {
 
 impl Url {
     /// Parse an absolute URL from a string.
+    ///
+    /// # Examples
+    ///
+    /// ```rust
+    /// use url::Url;
+    ///
+    /// let url = Url::parse("https://example.net").unwrap();
+    /// ```
     #[inline]
     pub fn parse(input: &str) -> Result<Url, ::ParseError> {
         Url::options().parse(input)