Flesh out the documentation for the core lifecycle annotations #2203
Conversation
This file contains 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
|
Thank you for taking the time for the updates. You'll notice some failures on the CI run. If you could clean those up, once we get a clean run we can merge. |
evanchooly
requested changes
Jan 22, 2023
mostly, these change can be made by running |
I also added a missing use-case from @PrePersist. I still didn't mention that it can take a Document parameter -- I can't think of a use-case for it, so treating it as an implementation detail
|
also added a missing use-case from @PrePersist. I still didn't mention that it can take a Document parameter -- I can't think of a use-case for it, so treating as an undocumented implementation detail |
|
Looks good! Thanks for the patch. |
evanchooly
pushed a commit
that referenced
this pull request
Jan 25, 2023
* Flesh out the documentation for the core lifecycle annotations * Comment clean up I also added a missing use-case from @PrePersist. I still didn't mention that it can take a Document parameter -- I can't think of a use-case for it, so treating it as an implementation detail
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.
No code changes -- just some documentation tweaks. The lifecycle document is a good start, but I still had questions about how each annotation worked, and documenting the annotations seems like the best place to put more info. (It's where I looked first, anyway.)
I tried to only use examples that could be potentially useful -- for example, I didn't add examples of @PostPersist functions that take zero parameters, because I couldn't think of any situation where that would be useful.
This is just a draft -- open to alterations.