on master help sign in
Merge pull request #5 from gregwebs/doc-raw

add warning documentation for raw Request fields

commit73e78f67fb5444636cf7a276c8d9d28779f75a11 authorMichael Snoyman <michael@snoyman.com> dateMon 9 May 2011, 20:15 (16 years ago) parent1b99c31a674f58
1 file changed+3−1
Network/Wai.hs+3−1
Network/Wai.hs+3−1
@@ -70,9 +70,11 @@ data Request = Request
7070 -- depending on backend; in a standalone server setting, this is most likely
7171 -- all information after the domain name. In a CGI application, this would be
7272 -- the information following the path to the CGI executable itself.
73+ -- Do not modify this raw value- modify pathInfo instead.
7374 , rawPathInfo :: B.ByteString
7475 -- | If no query string was specified, this should be empty. This value
7576 -- /will/ include the leading question mark.
77+ -- Do not modify this raw value- modify queryString instead.
7678 , rawQueryString :: B.ByteString
7779 -- | Generally the host requested by the user via the Host request header.
7880 -- Backends are free to provide alternative values as necessary. This value
@@ -88,7 +90,7 @@ data Request = Request
8890 , isSecure :: Bool
8991 -- | The client\'s host information.
9092 , remoteHost :: SockAddr
91− -- | Path info, broken down into individual components.
93+ -- | Path info in individual pieces- the url without a hostname/port and without a query string, split on forward slashes,
9294 , pathInfo :: [Text]
9395 -- | Parsed query string information
9496 , queryString :: H.Query