Allow Rendering of MigrationOnly Fields #16
Merged
Conversation
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
Modify the `render` function to also render fields marked as `MigrationOnly`. These can only be documented with peristent's inline docs, not via this library.
prikhi
commented
May 29, 2025
| @@ -9,6 +9,7 @@ you can use string literals to write documentation for the entity itself. The st | |||
| | `id` | integer (64) | You can document the user's ID field. | | |||
| | `firstName` | string | The user's first name. | | |||
| | `active` | boolean | Whether or not the user is able to log in. | | |||
| | `sqlOnly` | string | You can only write inline docs for MigrationOnly fields | | |||
There was a problem hiding this comment.
This will disappear if you run w/ persistent < 2.15.1.0, wasn't sure if I should include it or not
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Modify the
renderfunction to also render fields marked asMigrationOnly. These can only be documented with peristent's inline docs, not via this library.Tested with both
stack test&cabal test --constraint='persistent-2.15.1.0'