make note about why we don't support passwords in URLs (#450)

Byron · Byron · commit 970ec9b2e51a · 2022-08-31T16:58:08.000+08:00
Even though git does that.
diff --git a/crate-status.md b/crate-status.md
@@ -143,7 +143,9 @@ Check out the [performance discussion][git-traverse-performance] as well.
 * [x] convert URL to string
 * [x] API documentation
     * [ ] Some examples
-
+- **deviation**
+    * URLs may not contain passwords, which cannot be represent here and if present, will be ignored.
+    
 ### git-protocol
 * _abstract over protocol versions to allow delegates to deal only with a single way of doing things_
 * [x] **credentials**
diff --git a/git-url/src/lib.rs b/git-url/src/lib.rs
@@ -30,6 +30,8 @@ pub use scheme::Scheme;
 ///
 /// Additionally there is support for [deserialization][Url::from_bytes()] and serialization
 /// (_see the `Display::fmt()` implementation_).
+///
+/// Note that we do not support passing the password using the URL as it's likely leading to accidents.
 #[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone)]
 #[cfg_attr(feature = "serde1", derive(serde::Serialize, serde::Deserialize))]
 pub struct Url {
