Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the !no-migrate Entity Attribute #1530

Merged

Conversation

prikhi
Copy link
Contributor

@prikhi prikhi commented Apr 29, 2024

Add docs to the quasiquoter module about how the !no-migrate entity attribute will prevent any migrations from being generated for an entity. This is currently only "documented" in the source code:

isMigrated def = pack "no-migrate" `notElem` entityAttrs def

This has existed for a while, does it need a @since declaration or CHANGELOG entry in here?

Add docs to the quasiquoter module about how the `!no-migrate` entity
attribute will prevent any migrations from being generated for it. This
is currently only "documented" in the source code.
@@ -352,6 +352,17 @@ userAttrs = do
-- [["sad"],["sogood"]]
@

== @!no-migrate@
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I picked this spot since it's right after the attribute docs. I could make it go one level deeper so it's nested within them 🤷

@parsonsmatt parsonsmatt merged commit a4b4890 into yesodweb:master Apr 30, 2024
8 checks passed
@prikhi prikhi deleted the document-no-migrate branch April 30, 2024 19:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants