Skip to content

Commit b8e1a95

Browse files
committed
add error documentation on parse function
1 parent 743c394 commit b8e1a95

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/lib.rs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -252,6 +252,13 @@ impl Url {
252252
/// # }
253253
/// # run().unwrap();
254254
/// ```
255+
///
256+
/// # Errors
257+
///
258+
/// If the function can not parse an absolute URL from the given string,
259+
/// a [`ParseError`] variant will be returned.
260+
///
261+
/// [`ParseError`]: enum.ParseError.html
255262
#[inline]
256263
pub fn parse(input: &str) -> Result<Url, ::ParseError> {
257264
Url::options().parse(input)

0 commit comments

Comments
 (0)