git.iko.soy/typeable/servant
on master help sign in
Use 3rd-level headings

For some reason, 2nd-level headings are used for introductions and for each API endpoint, but then it immediately jumps to 4th-level headings. Instead, promote everything that's 4th-level to 3rd-level.

commit9d10fe13dd829eff188b5c1e414a28c88063a1b7 authorIvan Lazar Miljenovic <Ivan.Miljenovic@gmail.com> dateWed 11 Oct 2017, 10:48 (9 years ago) parentf960d97
1 file changed+7−7
compare with master
unifiedsplit
servant-docs/src/Servant/Docs/Internal.hs+7−7
servant-docs/src/Servant/Docs/Internal.hs+7−7
@@ -619,7 +619,7 @@ markdownWith RenderingOptions{..} api = unlines $
619619
620620 noteStr :: DocNote -> [String]
621621 noteStr nt =
622− ("#### " ++ nt ^. noteTitle) :
622+ ("### " ++ nt ^. noteTitle) :
623623 "" :
624624 intersperse "" (nt ^. noteBody) ++
625625 "" :
@@ -631,7 +631,7 @@ markdownWith RenderingOptions{..} api = unlines $
631631 authStr auths =
632632 let authIntros = mapped %~ view authIntro $ auths
633633 clientInfos = mapped %~ view authDataRequired $ auths
634− in "#### Authentication":
634+ in "### Authentication":
635635 "":
636636 unlines authIntros :
637637 "":
@@ -643,7 +643,7 @@ markdownWith RenderingOptions{..} api = unlines $
643643 capturesStr :: [DocCapture] -> [String]
644644 capturesStr [] = []
645645 capturesStr l =
646− "#### Captures:" :
646+ "### Captures:" :
647647 "" :
648648 map captureStr l ++
649649 "" :
@@ -655,7 +655,7 @@ markdownWith RenderingOptions{..} api = unlines $
655655 headersStr :: [Text] -> [String]
656656 headersStr [] = []
657657 headersStr l =
658− "#### Headers:" :
658+ "### Headers:" :
659659 "" :
660660 map headerStr l ++
661661 "" :
@@ -667,7 +667,7 @@ markdownWith RenderingOptions{..} api = unlines $
667667 paramsStr :: HTTP.Method -> [DocQueryParam] -> [String]
668668 paramsStr _ [] = []
669669 paramsStr m l =
670− ("#### " ++ cs m ++ " Parameters:") :
670+ ("### " ++ cs m ++ " Parameters:") :
671671 "" :
672672 map (paramStr m) l ++
673673 "" :
@@ -693,7 +693,7 @@ markdownWith RenderingOptions{..} api = unlines $
693693 rqbodyStr :: [M.MediaType] -> [(Text, M.MediaType, ByteString)]-> [String]
694694 rqbodyStr [] [] = []
695695 rqbodyStr types s =
696− ["#### Request:", ""]
696+ ["### Request:", ""]
697697 <> formatTypes types
698698 <> formatBodies _requestExamples s
699699
@@ -749,7 +749,7 @@ markdownWith RenderingOptions{..} api = unlines $
749749
750750 responseStr :: Response -> [String]
751751 responseStr resp =
752− "#### Response:" :
752+ "### Response:" :
753753 "" :
754754 ("- Status code " ++ show (resp ^. respStatus)) :
755755 ("- Headers: " ++ show (resp ^. respHeaders)) :