---

yaml
---
r: 147006
b: refs/heads/try2
c: 2c1acd7
h: refs/heads/master
v: v3

Author: dhodder

[refs]

@@ -5,7 +5,7 @@ refs/heads/snap-stage3: 78a7676898d9f80ab540c6df5d4c9ce35bb50463
 refs/heads/try: 519addf6277dbafccbb4159db4b710c37eaa2ec5
 refs/tags/release-0.1: 1f5c5126e96c79d22cb7862f75304136e204f105
 refs/heads/ndm: f3868061cd7988080c30d6d5bf352a5a5fe2460b
-refs/heads/try2: 0515e0541f6fed6e1b50d1b558ffe45625cd4a35
+refs/heads/try2: 2c1acd7998d9a99bd16ee59fe1fd68d1eece4c3e
 refs/heads/dist-snap: ba4081a5a8573875fed17545846f6f6902c8ba8d
 refs/tags/release-0.2: c870d2dffb391e14efb05aa27898f1f6333a9596
 refs/tags/release-0.3: b5f0d0f648d9a6153664837026ba1be43d3e2503

branches/try2/src/libextra/url.rs

@@ -22,21 +22,35 @@ use std::uint;
 /// A Uniform Resource Locator (URL).  A URL is a form of URI (Uniform Resource
 /// Identifier) that includes network location information, such as hostname or
 /// port number.
+///
+/// # Example
+///
+/// ```rust
+/// let url = Url { scheme: ~"https",
+///                 user: Some(UserInfo { user: ~"username", pass: None }),
+///                 host: ~"example.com",
+///                 port: Some(~"8080"),
+///                 path: ~"/foo/bar",
+///                 query: ~[(~"baz", ~"qux")],
+///                 fragment: Some(~"quz") };
+/// // https://[email protected]:8080/foo/bar?baz=qux#quz
+/// ```
 #[deriving(Clone, Eq)]
 pub struct Url {
-    /// The scheme part of a URL, such as `http`, `ftp` or `mailto`.
+    /// The scheme part of a URL, such as `https` in the above example.
     scheme: ~str,
-    /// A URL subcomponent for user authentication.
+    /// A URL subcomponent for user authentication.  `username` in the above example.
     user: Option<UserInfo>,
-    /// A domain name or IP address.  For example, `www.example.com`.
+    /// A domain name or IP address.  For example, `example.com`.
     host: ~str,
     /// A TCP port number, for example `8080`.
     port: Option<~str>,
-    /// The path component of a URL, for example `/users/jsmith`.
+    /// The path component of a URL, for example `/foo/bar`.
     path: ~str,
-    /// The query component of a URL.
+    /// The query component of a URL.  `~[(~"baz", ~"qux")]` represents the
+    /// fragment `baz=qux` in the above example.
     query: Query,
-    /// The fragment component.  Does not include the leading hash or pound sign.
+    /// The fragment component, such as `quz`.  Doesn't include the leading `#` character.
     fragment: Option<~str>
 }