document valid parameters

ibraheemdev · Feb 27, 2024 · 495eb1f · 495eb1f
1 parent 2970cff
commit 495eb1f
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/error.rs b/src/error.rs
@@ -12,6 +12,9 @@ pub enum InsertError {
         with: String,
     },
     /// Only one parameter per route segment is allowed.
+    ///
+    /// Prefixes are allowed before a parmeter, but not after it. For example,
+    /// `/foo-{bar}` is a valid route, but `/{bar}-foo` is not.
     InvalidParam,
     /// Parameters must be registered with a valid name.
     InvalidParamName,