doc(servant-foreign): reorder imports

The imports were ordered in the worst possible way, with all
undocumented small type definitions coming first and the actual meat
of the module coming at the very end, mixed in with irrelevant
functions.

This inverses that toxic ordering, showing the main function
first (`listFromAPI`) and then the main data type (`Req`) and the main
class (`HasForeignType`).
This commit is contained in:
Philip Patsch 2021-02-03 08:03:33 +01:00
parent c3a517cb4f
commit a0265097e8

View file

@ -3,20 +3,28 @@
-- --
-- See documentation of 'HasForeignType' for a simple example. 'listFromAPI' returns a list of all your endpoints and their foreign types, given a mapping from Haskell types to foreign types (conventionally called `ftypes` below). -- See documentation of 'HasForeignType' for a simple example. 'listFromAPI' returns a list of all your endpoints and their foreign types, given a mapping from Haskell types to foreign types (conventionally called `ftypes` below).
module Servant.Foreign module Servant.Foreign
( ArgType(..) ( listFromAPI
, Req(..)
, defReq
, HasForeignType(..)
, GenerateList(..)
, HasForeign(..)
, NoTypes
, ArgType(..)
, HeaderArg(..) , HeaderArg(..)
, QueryArg(..) , QueryArg(..)
, Req(..)
, ReqBodyContentType(..) , ReqBodyContentType(..)
, Segment(..) , Segment(..)
, isCapture
, captureArg
, SegmentType(..) , SegmentType(..)
, Url(..) , Url(..)
-- aliases -- * aliases
, Path , Path
, Arg(..) , Arg(..)
, FunctionName(..) , FunctionName(..)
, PathSegment(..) , PathSegment(..)
-- lenses -- * lenses
, argName , argName
, argType , argType
, argPath , argPath
@ -32,7 +40,7 @@ module Servant.Foreign
, queryArgName , queryArgName
, queryArgType , queryArgType
, headerArg , headerArg
-- prisms -- * prisms
, _PathSegment , _PathSegment
, _HeaderArg , _HeaderArg
, _ReplaceHeaderArg , _ReplaceHeaderArg
@ -41,16 +49,7 @@ module Servant.Foreign
, _Normal , _Normal
, _Flag , _Flag
, _List , _List
-- rest of it -- * re-exports
, HasForeign(..)
, HasForeignType(..)
, GenerateList(..)
, NoTypes
, captureArg
, isCapture
, defReq
, listFromAPI
-- re-exports
, module Servant.API , module Servant.API
, module Servant.Foreign.Inflections , module Servant.Foreign.Inflections
) where ) where