Fix typos and rendering issues in docs #1314
Conversation
| @@ -203,7 +203,7 @@ You can automatically get ToJSON and FromJSON instances for any entity by adding | |||
| Person json | |||
| name Text | |||
| @ | |||
| Requires @{-# LANGUAGE FlexibleInstances #-}@ | |||
| Requires @\{\-\# LANGUAGE FlexibleInstances \#\-\}@ | |||
There was a problem hiding this comment.
Requires @{-# LANGUAGE FlexibleInstances #-}@ would render as Requires @@, see here under JSON instances. Maybe there's a better way to solve this than escaping each character?
| @@ -16,7 +16,7 @@ module Database.Persist | |||
| -- This syntax allows you to customize the resulting Haskell datatypes and | |||
| -- database schema. See "Database.Persist.Quasi" for details on that definition | |||
| -- language. | |||
| -- | |||
|
|
|||
There was a problem hiding this comment.
This was needed in order to properly render the subheading Reference Schema & Dataset.
| @@ -216,7 +216,7 @@ Person sql=peoples | |||
| name Text | |||
| @ | |||
|
|
|||
| == Change table/collection key definition (field name and/or type, persistent >= 2.1) | |||
| == Change table/collection key definition (field name and\/or type, persistent >= 2.1) | |||
There was a problem hiding this comment.
Escaping of the 2nd / was needed to render properly, see Change tablecollection key definition (field name andor type, persistent >= 2.1 on this page.
|
Found a couple of small issues in the docs that I figured I could have a go at. Since I'm a first-time contributor, CI won't run automatically so I haven't been able to see if it succeeds and cross off the task above, but the PR should be ready for review! |
|
No worries! |
Fixes a couple of typos and Haddock rendering issues.
Before submitting your PR, check that you've:
stylish-haskellon any changed files..editorconfigfile for details)After submitting your PR: