docs: Fix foreign key KDocs that swap parent and child references #2004
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
KDocs introduced to the ForeignKeyConstraint data class incorrectly switches parent references table columns with child referencing table columns. The KDocs for the functions that create this constraint have also been cleaned up and samples added.
bog-walk
commented
Feb 22, 2024
| * @see [references] | ||
| * @sample org.jetbrains.exposed.sql.tests.shared.dml.JoinTests.testJoin04 |
There was a problem hiding this comment.
This is supposed to be a link to an overload function, but it goes nowhere because of KT-15984.
e5l
approved these changes
Feb 22, 2024
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.
Running tests with references and properties of the data class
ForeignKeyConstrainthave made it clear that I incorrectly swapped the referencing table ("child") with the referenced table ("parent") in the class KDocs.The KDocs now properly match the fields/behavior seen when the class members are accessed in tests.
The KDocs for functions that create foreign keys have also been cleaned up and samples added.