Update Delete Godoc to describe soft delete behaviour #5554
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
bruc3mackenzi3
changed the title
|
@jinzhu is it possible to get a review on this PR? I'm interested in making further contributions to GORM's documentation. If there's a desire for these sorts of improvements I will follow this PR up with more like it. Cheers! |
jinzhu
pushed a commit
that referenced
this pull request
Sep 22, 2022
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.
What did this pull request do?
gorm's Delete() method performs either a soft or hard delete, depending on whether the passed data model includes a
deletedAtfield. This is detailed here in the docs and this PR adds this to the Godoc comment.I've also cleaned up the grammar to make the language of the comment consistent.
User Case Description
As a new user to gorm I found myself referencing the external docs at gorm.io to learn the behaviour of this method. Adding key details to inline documentation improves the user experience.
If there is an appetite for contribution to documentation I would like to submit more PRs like this across the codebase.