Documentation Fields on EntityDef and FieldDef#865
Merged
parsonsmatt merged 7 commits intoyesodweb:masterfrom Apr 11, 2019
Merged
Documentation Fields on EntityDef and FieldDef#865parsonsmatt merged 7 commits intoyesodweb:masterfrom
parsonsmatt merged 7 commits intoyesodweb:masterfrom
Conversation
Collaborator
Author
|
@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 |
Member
|
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>
.
|
parsonsmatt
changed the title
Member
|
LGTM. Are you planning to work on the parser support also ? |
Collaborator
Author
|
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
@sincedeclarations to the HaddockAfter submitting your PR: