Add doc comment for extra::url::query_to_str

rust-lang · Nov 17, 2013 · 48f76a0 · 48f76a0 · bors · Nov 17, 2013
1 parent 5208332
commit 48f76a0
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/src/libextra/url.rs b/src/libextra/url.rs
@@ -364,6 +364,16 @@ fn query_from_str(rawquery: &str) -> Query {
     return query;
 }
 
+/**
+ * Converts an instance of a URI `Query` type to a string.
+ *
+ * # Example
+ *
+ * ```rust
+ * let query = ~[(~"title", ~"The Village"), (~"north", ~"52.91"), (~"west", ~"4.10")];
+ * println(query_to_str(&query));  // title=The%20Village&north=52.91&west=4.10
+ * ```
+ */
 pub fn query_to_str(query: &Query) -> ~str {
     let mut strvec = ~[];
     for kv in query.iter() {