summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorSam Scott <sam.scott89@gmail.com>2017-05-23 09:39:08 +0100
committerSam Scott <sam.scott89@gmail.com>2017-05-23 09:39:08 +0100
commit15137be4a0b02a40bea178127472554d8a7bba3a (patch)
tree76f6bb915afddd287f361b4b8dcf296fb865c6a6 /src
parent6f22cff63ad58c722293f8d74c978a0bf616be67 (diff)
Add note in docs about using integer keys.
Diffstat (limited to 'src')
-rw-r--r--src/lib.rs4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/lib.rs b/src/lib.rs
index dff822e..b7eee87 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -22,6 +22,10 @@
//! However, after the top level you should find all supported types can be
//! de/serialized.
//!
+//! Note that integer keys are reserved for array indices. That is, a string of
+//! the form `a[0]=1&a[1]=3` will deserialize to the ordered sequence `a =
+//! [1,3]`.
+//!
//! ## Usage
//!
//! See the examples folder for a more detailed introduction.