Documentation Fields on EntityDef and FieldDef

[parsonsmatt]

This PR adds documentation fields to entities, opening the door for the QuasiQuoter to add them in later.

---

Before submitting your PR, check that you've:

• Bumped the version number
• Documented new APIs with Haddock markup
• Added @since declarations to the Haddock

After submitting your PR:

• Update the Changelog.md file with a link to your PR
• Check that CI passes (or if it fails, for reasons unrelated to your change, like CI timeouts)

[parsonsmatt]

@psibi @MaxGabriel How would y'all feel about getting this merged now, and allowing documentation extensions to come later? We've got an internal library for documenting persistent entities in a separate EDSL, and it would really simplify a lot of that library's logic for the documentation comments to exist on the EntityDef types themselves.

[MaxGabriel]

That sounds alright to me. Seems like a natural progression. There should probably be a comment saying that the parser support isn’t added yet though

…

On Tue, Apr 2, 2019 at 12:15 PM Matt Parsons ***@***.***> wrote: @psibi <https://github.com/psibi> @MaxGabriel <https://github.com/MaxGabriel> How would y'all feel about getting this merged now, and allowing documentation extensions to come later? We've got an internal library for documenting persistent entities in a separate EDSL, and it would really simplify a lot of that library's logic for the documentation comments to exist on the EntityDef types themselves. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#865 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABNxIePWhAxQsRj6c4YPzObuY5F-eImJks5vc6xLgaJpZM4cTZnI> .

[psibi]

LGTM. Are you planning to work on the parser support also ?

[parsonsmatt]

Yeah, I'm going to implement the parsing side of things. I've got an internal library at work for adding this documentation after-the-fact in Haskell which I'm going to open-source first.