@@ -127,7 +127,7 @@
127127-- > -- notes.
128128-- > extra :: ExtraInfo TestApi
129129-- > extra =
130−-- > safeInfo (Proxy :: Proxy ("greet" :> Capture "greetid" Text :> Delete)) $
130+-- > extraInfo (Proxy :: Proxy ("greet" :> Capture "greetid" Text :> Delete)) $
131131-- > defAction & headers <>~ ["unicorns"]
132132-- > & notes <>~ [ DocNote "Title" ["This is some text"]
133133-- > , DocNote "Second secton" ["And some more"]
@@ -149,7 +149,7 @@ module Servant.Docs
149149 ( -- * 'HasDocs' class and key functions
150150 HasDocs(..), docs, markdown
151151 -- * Generating docs with extra information
152− , ExtraInfo(..), docsWith, docsWithIntros, safeInfo
152+ , ExtraInfo(..), docsWith, docsWithIntros, extraInfo
153153
154154 , -- * Classes you need to implement for your types
155155 ToSample(..)
@@ -317,7 +317,7 @@ data DocNote = DocNote
317317-- | Type of extra information that a user may wish to "union" with their
318318-- documentation.
319319--
320−-- These are intended to be built using safeInfo.
320+-- These are intended to be built using extraInfo.
321321-- Multiple ExtraInfo may be combined with the monoid instance.
322322newtype ExtraInfo layout = ExtraInfo (HashMap Endpoint Action)
323323instance Monoid (ExtraInfo a) where
@@ -448,15 +448,15 @@ type family IsIn (endpoint :: *) (api :: *) :: Constraint where
448448--
449449-- > extra :: ExtraInfo TestApi
450450-- > extra =
451−-- > safeInfo (Proxy :: Proxy ("greet" :> Capture "greetid" Text :> Delete)) $
451+-- > extraInfo (Proxy :: Proxy ("greet" :> Capture "greetid" Text :> Delete)) $
452452-- > defAction & headers <>~ ["unicorns"]
453453-- > & notes <>~ [ DocNote "Title" ["This is some text"]
454454-- > , DocNote "Second secton" ["And some more"]
455455-- > ]
456456
457−safeInfo :: (IsIn endpoint layout, HasLink endpoint, HasDocs endpoint)
457+extraInfo :: (IsIn endpoint layout, HasLink endpoint, HasDocs endpoint)
458458 => Proxy endpoint -> Action -> ExtraInfo layout
459−safeInfo p action =
459+extraInfo p action =
460460 let api = docsFor p (defEndpoint, defAction)
461461 -- Assume one endpoint, HasLink constraint means that we should only ever
462462 -- point at one endpoint.
@@ -471,7 +471,7 @@ safeInfo p action =
471471-- will be "unioned" with the automatically generated endpoint documentation.
472472--
473473-- You are expected to build up the ExtraInfo with the Monoid instance and
474−-- 'safeInfo'.
474+-- 'extraInfo'.
475475--
476476-- If you only want to add an introduction, use 'docsWithIntros'.
477477docsWith :: HasDocs layout