Documentation revamp

CHANGELOG

@@ -1,43 +1,44 @@
-* 0.12.3 [2019-02-24]
+# Changelog for `http-types`
 
-Remove now-invalid doctest options from doctests.hs.
+## 0.12.4 [2023-11-29]
 
-* 0.12.2 [2018-09-26]
+* Add `Data` and `Generic` instances to `ByteRange`, `StdMethod`, `Status` and `HttpVersion`.
+* Rework of all the documentation, with the addition of `@since` notations.
 
-Add new parseQueryReplacePlus function, which allows specifying whether to replace '+' with ' '.
+## 0.12.3 [2019-02-24]
 
-Add header name constants for "Prefer" and "Preference-Applied" (RFC 7240).
+* Remove now-invalid doctest options from `doctests.hs`.
 
-* 0.12.1 [2018-01-31]
+## 0.12.2 [2018-09-26]
 
-Add new functions for constructing a query URI where not all parts are escaped.
+* Add new `parseQueryReplacePlus` function, which allows specifying whether to replace `'+'` with `' '`.
+* Add header name constants for "Prefer" and "Preference-Applied" (RFC 7240).
 
-* 0.12 [2018-01-28]
+## 0.12.1 [2018-01-31]
 
-URI encoding is now back to upper-case hexadecimal, as that is the preferred canonicalization, and the previous change caused issues with URI
-signing in at least amazonka.
+* Add new functions for constructing a query URI where not all parts are escaped.
 
-* 0.11 [2017-11-29]
+## 0.12 [2018-01-28]
 
-Remove dependency on blaze-builder. (Note that as a side effect of this, URI encoding is now using lower-case rather than uppercase hexadecimal.)
+* URI encoding is now back to upper-case hexadecimal, as that is the preferred canonicalization, and the previous change caused issues with URI signing in at least `amazonka`.
 
-Add Bounded instance to Status.
+## 0.11 [2017-11-29]
 
-Re-export more status codes and http20 from Network.HTTP.Types.
+* Remove dependency on `blaze-builder`. (Note that as a side effect of this, URI encoding is now using lower-case rather than upper-case hexadecimal.)
+* Add `Bounded` instance to `Status`.
+* Re-export more status codes and `http20` from `Network.HTTP.Types`.
 
-* 0.10 [2017-10-22]
+## 0.10 [2017-10-22]
 
-New status codes, new headers.
+* New status codes, new headers.
+* Fixed typo in `imATeapot`, added missing `toEnum`.
+* Oh, and `http20`.
 
-Fixed typo in imATeapot, added missing toEnum.
+## 0.9.1 [2016-06-04]
 
-Oh, and http20.
+* New function: `parseByteRanges`.
+* Support for HTTP status 422 "Unprocessable Entity" (RFC 4918).
 
-* 0.9.1 [2016-06-04]
+## 0.9 [2015-10-09]
 
-New function: parseByteRanges.
-Support for HTTP status 422 "Unprocessable Entity" (RFC 4918).
-
-* 0.9 [2015-10-09]
-
-No changelog was maintained up to version 0.9.
+* No changelog was maintained up to version `0.9`.

Network/HTTP/Types.hs

@@ -1,6 +1,11 @@
 module Network.HTTP.Types (
     -- * Methods
+
+    -- | __For more information__: "Network.HTTP.Types.Method"
+
     Method,
+
+    -- ** Constants
     methodGet,
     methodPost,
     methodHead,
@@ -11,19 +16,29 @@ module Network.HTTP.Types (
     methodOptions,
     methodPatch,
     StdMethod (..),
+
+    -- ** Parsing and redering methods
     parseMethod,
     renderMethod,
     renderStdMethod,
 
     -- * Versions
+
+    -- | __For more information__: "Network.HTTP.Types.Version"
+
     HttpVersion (..),
     http09,
     http10,
     http11,
     http20,
 
     -- * Status
+
+    -- | __For more information__: "Network.HTTP.Types.Status"
+
     Status (..),
+
+    -- ** Constants
     mkStatus,
     status100,
     continue100,
@@ -127,6 +142,8 @@ module Network.HTTP.Types (
 
     -- * Headers
 
+    -- | __For more information__: "Network.HTTP.Types.Header"
+
     -- ** Types
     Header,
     HeaderName,
@@ -165,24 +182,17 @@ module Network.HTTP.Types (
 
     -- * URI
 
-    -- ** Query string
-    QueryItem,
+    -- | __For more extensive information__: "Network.HTTP.Types.URI"
+
+    -- ** Query strings
+
+    -- *** Query
     Query,
-    SimpleQueryItem,
-    SimpleQuery,
-    simpleQueryToQuery,
+    QueryItem,
     renderQuery,
     renderQueryBuilder,
-    renderSimpleQuery,
     parseQuery,
-    parseSimpleQuery,
-
-    -- ** Escape only parts
-    renderQueryPartialEscape,
-    renderQueryBuilderPartialEscape,
-    EscapeItem (..),
-    PartialEscapeQueryItem,
-    PartialEscapeQuery,
+    parseQueryReplacePlus,
 
     -- *** Text query string (UTF8 encoded)
     QueryText,
@@ -191,22 +201,38 @@ module Network.HTTP.Types (
     renderQueryText,
     parseQueryText,
 
+    -- *** SimpleQuery
+    SimpleQuery,
+    SimpleQueryItem,
+    simpleQueryToQuery,
+    renderSimpleQuery,
+    parseSimpleQuery,
+
+    -- *** PartialEscapeQuery
+    PartialEscapeQuery,
+    PartialEscapeQueryItem,
+    EscapeItem (..),
+    renderQueryPartialEscape,
+    renderQueryBuilderPartialEscape,
+
     -- ** Generalized query types
     QueryLike (toQuery),
 
-    -- ** Path segments
-    encodePathSegments,
-    decodePathSegments,
-    encodePathSegmentsRelative,
+    -- ** Path
 
-    -- ** Path (segments + query string)
+    -- *** Segments + Query String
     extractPath,
     encodePath,
     decodePath,
 
+    -- *** Path Segments
+    encodePathSegments,
+    encodePathSegmentsRelative,
+    decodePathSegments,
+
     -- ** URL encoding / decoding
-    urlEncodeBuilder,
     urlEncode,
+    urlEncodeBuilder,
     urlDecode,
 )
 where