Skip to content

Commit 78898a7

Browse files
committed
Adjust documentation to be a bit less verbose.
1 parent c836c3d commit 78898a7

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

gix-url/src/lib.rs

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ pub enum ArgumentSafety<'a> {
7676

7777
/// A URL with support for specialized git related capabilities.
7878
///
79-
/// Additionally there is support for [deserialization](Url::from_bytes()) and [serialization](Url::to_bstring()).
79+
/// Additionally, there is support for [deserialization](Url::from_bytes()) and [serialization](Url::to_bstring()).
8080
///
8181
/// # Mutability Warning
8282
///
@@ -87,15 +87,13 @@ pub enum ArgumentSafety<'a> {
8787
///
8888
/// # Serialization
8989
///
90-
/// This type does not implement `Into<String>` or `From<Url> for String` because URLs can contain
91-
/// non-UTF-8 sequences in the path component. Use [to_bstring()](Url::to_bstring()) for lossless
92-
/// serialization, or use the [`Display`](std::fmt::Display) trait for a UTF-8 representation that
93-
/// redacts passwords for safe logging.
90+
/// This type does not implement `Into<String>`, `From<Url> for String` because URLs
91+
/// can contain non-UTF-8 sequences in the path component when parsed from raw bytes.
92+
/// Use [to_bstring()](Url::to_bstring()) for lossless serialization, or use the [`Display`](std::fmt::Display)
93+
/// trait for a UTF-8 representation that redacts passwords for safe logging.
9494
///
9595
/// When the `serde` feature is enabled, this type implements `serde::Serialize` and `serde::Deserialize`,
96-
/// which will serialize *all* fields including passwords. The password is never serialized through the
97-
/// `Display` trait or in any other context unless the `serde` feature is enabled and serde serialization
98-
/// is explicitly used.
96+
/// which will serialize *all* fields, including the password.
9997
///
10098
/// # Security Warning
10199
///

0 commit comments

Comments
 (0)